openapi: 3.2.0 info: description: 'Use the Resource Manager API to automate deployment and operations for all Oracle Cloud Infrastructure resources. Using the infrastructure-as-code (IaC) model, the service is based on Terraform, an open source industry standard that lets DevOps engineers develop and deploy their infrastructure anywhere. For more information, see [the Resource Manager documentation](/iaas/Content/ResourceManager/home.htm). ' title: Resource Manager API version: '20180917' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/bf83127e80f19898e866a3bcc17cec35ff9d30707a025355b74e21bfacf9edf0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Resource Manager 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/bf83127e80f19898e866a3bcc17cec35ff9d30707a025355b74e21bfacf9edf0.yaml what: the harvested document for Resource Manager API servers: - url: http://127.0.0.1/20180917 - url: https://127.0.0.1/20180917 tags: - description: Manages infrastructure and other Oracle cloud resources. name: ResourceManager paths: /configurationSourceProviders: get: description: 'Lists configuration source providers according to the specified filter. For more information, see [Listing Configuration Source Providers](/iaas/Content/ResourceManager/Tasks/list-csp.htm). - For `compartmentId`, lists all configuration source providers in the matching compartment. - For `configurationSourceProviderId`, lists the matching configuration source provider. ' operationId: ListConfigurationSourceProviders parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdForConfigurationSourceProviderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByConfigSourceProviderTypeQueryParam' responses: 200: description: The request was accepted for processing. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationSourceProviderCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists configuration source providers. tags: - ResourceManager x-example: 'Sample 1: List all configuration source providers in a compartment, sorted by display name GET /20180917/configurationSourceProviders?compartmentId=<compartment_OCID>&sortBy=displayName Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: List the specified configuration source provider in a compartment GET /20180917/configurationSourceProviders?configurationSourceProviderId=<configurationsourceprovider_OCIDD> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 3: List the configuration source providers in a compartment, filtered by config source provider type (GitHub/GitLab) GET /20180917/configurationSourceProviders?compartmentId=<compartment_OCID>&configSourceProviderType=<config_source_provider_type>&sortBy=displayName Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ConfigurationSourceProviderSummary' post: description: 'Creates a configuration source provider in the specified compartment. For more information, see [Creating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/create-csp.htm). ' operationId: CreateConfigurationSourceProvider parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: The request was accepted for processing. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationSourceProvider' 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/DefaultError' summary: Creates a configuration source provider in the specified compartment. tags: - ResourceManager x-example: "POST /20180917/configurationSourceProviders\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Configuration Source Provider\",\n \"description\": \"Example Git Source\",\n \"configSourceProviderType\": \"GITLAB_ACCESS_TOKEN\",\n \"apiEndpoint\": \"https://gitlab.com\",\n \"accessToken\": \"<token>\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationSourceProviderDetails' description: The properties for creating a ConfigurationSourceProvider. required: true /configurationSourceProviders/{configurationSourceProviderId}: delete: description: 'Deletes the specified configuration source provider. For more information, see [Deleting a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/delete-csp.htm). ' operationId: DeleteConfigurationSourceProvider parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' responses: 204: description: The request was accepted for processing. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Deletes the specified configuration source provider. tags: - ResourceManager x-example: 'DELETE /20180917/configurationSourceProviders/<configurationsourceprovider_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ConfigurationSourceProvider' get: description: 'Gets the properties of the specified configuration source provider. For more information, see [Getting a Configuration Source Provider''s Details](/iaas/Content/ResourceManager/Tasks/get-csp.htm). ' operationId: GetConfigurationSourceProvider parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' responses: 200: description: The request was accepted for processing. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationSourceProvider' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the properties of the specified configuration source provider. tags: - ResourceManager x-example: 'GET /20180917/configurationSourceProviders/<configurationsourceprovider_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the properties of the specified configuration source provider. For more information, see [Updating a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/update-csp.htm). ' operationId: UpdateConfigurationSourceProvider parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' responses: 200: description: The request was accepted for processing. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationSourceProvider' 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/DefaultError' summary: Updates the properties of the specified configuration source provider. tags: - ResourceManager x-example: "PUT /20180917/configurationSourceProviders/<configurationsourceprovider_OCID>\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"My Renamed Configuration Source Provider\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationSourceProviderDetails' description: 'Updated information provided for the ConfigurationSourceProvider. ' required: true /configurationSourceProviders/{configurationSourceProviderId}/actions/changeCompartment: post: description: 'Moves a configuration source provider into a different compartment within the same tenancy. For more information, see [Moving a Configuration Source Provider](/iaas/Content/ResourceManager/Tasks/change-compartment-csp.htm). ' operationId: ChangeConfigurationSourceProviderCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/ConfigurationSourceProviderIdPathParam' responses: 204: description: The request to move the configuration source provider to a different compartment was accepted for processing. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Moves a ConfigurationSourceProvider into a different compartment. When provided, If-Match is checked against ETag values of the ConfigurationSourceProvider. tags: - ResourceManager x-example: "POST /20180917/configurationSourceProviders/<configurationsourceprovider_OCID>/actions/changeCompartment\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" x-related-resource: '#/definitions/ConfigurationSourceProvider' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeConfigurationSourceProviderCompartmentDetails' description: Defines the properties of changeConfigurationSourceProviderCompartment operation. required: true /jobs: get: description: 'Lists jobs according to the specified filter. By default, the list is ordered by time created. For more information, see [Listing Jobs](/iaas/Content/ResourceManager/Tasks/list-jobs.htm). - To list all jobs in a stack, provide the stack [OCID](/iaas/Content/General/Concepts/identifiers.htm). - To list all jobs in a compartment, provide the compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). - To return a specific job, provide the job [OCID](/iaas/Content/General/Concepts/identifiers.htm). (Equivalent to [GetStack](#/en/resourcemanager/latest/Stack/GetStack).) ' operationId: ListJobs parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StackIdQueryParam' - $ref: '#/components/parameters/IdForJobQueryParam' - description: 'A filter that returns all resources that match the specified lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Job/lifecycleState' schema: type: string - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of jobs. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/JobSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: 'List all jobs related to a stack or compartment. By default, the list is ordered by time created. You can alter the ordering by using `SortByQueryParam` and `SortOrderQueryParam`. ' tags: - ResourceManager x-example: 'Sample 1: List jobs in a compartment. GET /20180917/jobs/<job_OCID>/logs&compartmentId=<compartment_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: List jobs in a stack. GET /20180917/jobs/<job_OCID>/logs&stackId=<stack_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a job. For more information, see [Creating a Job](/iaas/Content/ResourceManager/Tasks/create-job.htm). ' operationId: CreateJob parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: Successful operation. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 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/DefaultError' summary: Create a Job. tags: - ResourceManager x-example: "POST /20180917/jobs\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Job Display Name\",\n \"stackId\": \"ocid1.ormstack.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"operation\": \"APPLY\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateJobDetails' description: The properties for a request to create a job. required: true /jobs/{jobId}: delete: description: 'Indicates the intention to cancel the specified job. Cancellation of the job is not immediate, and may be delayed, or may not happen at all. You can optionally choose forced cancellation by setting `isForced` to true. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources. For more information, see [Canceling a Job](/iaas/Content/ResourceManager/Tasks/cancel-job.htm). ' operationId: CancelJob parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IsForcedQueryParam' responses: 202: description: Confirmation that the job cancellation has begun. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Cancel a Job tags: - ResourceManager x-example: 'DELETE /20180917/jobs/<job_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' get: description: 'Gets the properties of the specified job. For more information, see [Getting a Job''s Details](/iaas/Content/ResourceManager/Tasks/get-job.htm). ' operationId: GetJob parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: A job object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get details of a specific job. tags: - ResourceManager x-example: 'GET /20180917/jobs/<job_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified job. For more information, see [Updating a Job](/iaas/Content/ResourceManager/Tasks/update-job.htm). ' operationId: UpdateJob parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: Returns the updated job object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 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/DefaultError' summary: Update a Job. tags: - ResourceManager x-example: "PUT /20180917/jobs/<job_OCID>\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"example_job\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJobDetails' description: Updates properties for the specified job. required: true /jobs/{jobId}/associatedResources: get: description: 'Gets the list of resources associated with the specified job. For more information, see [Listing Job Resources](/iaas/Content/ResourceManager/Tasks/list-job-resources.htm). ' operationId: ListJobAssociatedResources parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TerraformResourceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of associated resources. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssociatedResourcesCollection' 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/DefaultError' summary: Gets the list of resources associated with the specified job. tags: - ResourceManager x-example: 'Sample 1: Gets all the resources associated with the given job GET /20180917/jobs/<job_OCID>/associatedResources Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: Gets compute instances (`oci_core_instance`) associated with the given job GET /20180917/jobs/<job_OCID>/associatedResource?resourceType=oci_core_instance Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AssociatedResourceSummary' /jobs/{jobId}/detailedLogContent: get: description: 'Returns the Terraform detailed log content for the specified job in plain text. [Learn about Terraform detailed log.](https://www.terraform.io/docs/internals/debugging.html) For more information, see [Getting Detailed Log Content for a Job](/iaas/Content/ResourceManager/Tasks/get-job-detailed-log-content.htm). ' operationId: GetJobDetailedLogContent parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: Successfully returned the Terraform detailed log content for the job. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: text/plain; charset=utf-8: schema: type: string 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/DefaultError' summary: Gets job detailed log content. tags: - ResourceManager x-related-resource: '#/definitions/Job' /jobs/{jobId}/logs: get: description: 'Returns console log entries for the specified job in JSON format. For more information, see [Getting Logs for a Job](/iaas/Content/ResourceManager/Tasks/get-job-logs.htm). ' operationId: GetJobLogs parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' - description: 'A filter that returns only logs of a specified type. ' in: query name: type required: false style: form explode: true schema: type: array items: type: string x-obmcs-enumref: '#/definitions/LogEntry/type' - description: 'A filter that returns only log entries that match a given severity level or greater. ' in: query name: levelGreaterThanOrEqualTo required: false x-obmcs-enumref: '#/definitions/LogEntry/level' schema: type: string - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/LogTimestampGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/LogTimestampLessThanOrEqualToQueryParam' responses: 200: description: An array of log entries. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LogEntry' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets log entries for a job tags: - ResourceManager x-example: 'Sample 1: List log entries for the specified job that are at error level or greater. GET /20180917/jobs/<job_OCID>/logs&levelGreaterThanOrEqualTo=ERROR Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: List log entries for the specified job that have timestamps equal to or greater than midnight on February 1st. GET /20180917/jobs/<job_OCID>/logs&timestampGreaterThanOrEqualTo=2020-02-01T12:00:00.000Z Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' /jobs/{jobId}/logs/content: get: description: 'Returns the raw log file for the specified job in text format. The file includes a maximum of 100,000 log entries. For more information, see [Getting Logs Content for a Job](/iaas/Content/ResourceManager/Tasks/get-job-logs-content.htm). ' operationId: GetJobLogsContent parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: Logs. headers: opc-request-id: description: Unique identifier for the request schema: type: string content: text/plain; charset=utf-8: schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the raw logs for a job. tags: - ResourceManager x-example: 'GET /20180917/jobs/<job_OCID>/logs/content Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' /jobs/{jobId}/outputs: get: description: 'Gets the list of outputs associated with the specified job. For more information, see [Listing Job Outputs](/iaas/Content/ResourceManager/Tasks/list-job-outputs.htm). ' operationId: ListJobOutputs parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of job outputs. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobOutputsCollection' 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/DefaultError' summary: Gets the list of outputs associated with the specified job. tags: - ResourceManager x-example: 'Sample 1: Gets all the outputs associated with the given job GET /20180917/jobs/<job_OCID>/outputs Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/JobOutputSummary' /jobs/{jobId}/tfConfig: get: description: 'Returns the Terraform configuration for the specified job in zip format. If no zip file is found, returns an error. For more information, see [Getting a Job Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-job-tf-config.htm). ' operationId: GetJobTfConfig parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: Terraform configuration. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/zip: schema: format: binary type: string 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/DefaultError' summary: Get zipped Terraform configuration used for a specific job. tags: - ResourceManager x-example: 'GET /20180917/jobs/<job_OCID>/tfConfig Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' /jobs/{jobId}/tfPlan: get: description: 'Returns the output of the specified Terraform plan job in binary or JSON format. For more information, see [Getting the Terraform Output for a Plan Job](/iaas/Content/ResourceManager/Tasks/get-job-tf-plan.htm). ' operationId: GetJobTfPlan parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/TfPlanFormatQueryParam' responses: 200: description: Successfully returned output of the plan job. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/octet-stream: schema: format: binary type: string 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/DefaultError' summary: Gets terraform plan output file with contents in binary or json format tags: - ResourceManager x-example: 'Sample 1: Binary format option for downloading Terraform plan output GET /20180917/jobs/<job_OCID>/tfPlan?tfPlanFormat=BINARY Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: JSON format option for downloading Terraform plan output GET /20180917/jobs/<job_OCID>/tfPlan?tfPlanFormat=JSON Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' /jobs/{jobId}/tfState: get: description: 'Returns the Terraform state for the specified job. For more information, see [Getting a Job Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-job-tf-config.htm). ' operationId: GetJobTfState parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: A Terraform state. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/octet-stream: schema: format: binary type: string 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/DefaultError' summary: Get Terraform state output from a specified job. tags: - ResourceManager x-example: 'GET /20180917/jobs/<job_OCID>/tfState Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Job' /privateEndpoints: get: description: 'Lists private endpoints according to the specified filter. For more information, see [Listing Private Endpoints](/iaas/Content/ResourceManager/Tasks/list-private-endpoints.htm). - For `compartmentId`, lists all private endpoints in the matching compartment. - For `privateEndpointId`, lists the matching private endpoint. ' operationId: ListPrivateEndpoints parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PrivateEndpointIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByVcnIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Successfully retrieved the list of private endpoints. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists private endpoints according to specified filter. tags: - ResourceManager x-example: 'Sample 1: List all private endpoints in a compartment, sorted by display name GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&sortBy=displayName Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: List the specified private endpoint in its compartment GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&privateEndpointId=<privateendpoint_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 3: List private endpoints in the specified compartment, filtered by VCN GET /20180917/privateEndpoints?compartmentId=<compartment_OCID>&vcnId=<vcn_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 4: List the specified private endpoint GET /20180917/privateEndpoints?privateEndpointId=<privateendpoint_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PrivateEndpointSummary' post: description: 'Creates a private endpoint in the specified compartment. For more information, see [Creating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/create-private-endpoints.htm). ' operationId: CreatePrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: Successfully accepted the request. The private endpoint will be created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpoint' 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/DefaultError' summary: Creates a private endpoint in the specified compartment. tags: - ResourceManager x-example: "POST /20180917/privateEndpoints\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"compartmentId\": \"ocid1.compartment.oc1..<compartment_OCID>\",\n \"displayName\": \"My Private Endpoint\",\n \"description\": \"Example Private Endpoint\",\n \"vcnId\": \"ocid1.vcn.oc1.phx.<vcn_OCID>\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.<subnet_OCID>\",\n \"nsgIdList\": [\"ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>\",\"ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>\"],\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n },\n \"securityAttributes\": {\n \"oracle-zpr\": {\n \"MaxEgressCount\": {\n \"mode\": \"enforce\", \n \"value\": \"45\" \n }\n }\n }\n }\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePrivateEndpointDetails' description: Creation details for a private endpoint. required: true /privateEndpoints/{privateEndpointId}: delete: description: 'Deletes the specified private endpoint. For more information, see [Deleting a Private Endpoint](/iaas/Content/ResourceManager/Tasks/delete-private-endpoints.htm). ' operationId: DeletePrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' responses: 204: description: The private endpoint was deleted. headers: opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. 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/DefaultError' summary: Deletes the specified private endpoint. tags: - ResourceManager x-example: 'DELETE /20180917/privateEndpoints/<privateendpoint_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PrivateEndpoint' get: description: 'Gets the specified private endpoint. For more information, see [Getting a Private Endpoint''s Details](/iaas/Content/ResourceManager/Tasks/get-private-endpoints.htm). ' operationId: GetPrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' responses: 200: description: Successfully retrieved the private endpoint. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the specified private endpoint. tags: - ResourceManager x-example: 'GET /20180917/privateEndpoints/<privateendpoint_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other header> ' put: description: 'Updates the specified private endpoint. For more information, see [Updating a Private Endpoint](/iaas/Content/ResourceManager/Tasks/update-private-endpoints.htm). ' operationId: UpdatePrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' responses: 200: description: Successfully accepted the request. The private endpoint will be updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpoint' 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/DefaultError' summary: Updates the specified private endpoint. tags: - ResourceManager x-example: "PUT /20180917/privateEndpoints/<privateendpoint_OCID>\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"My renamed private endpoint\",\n \"description\" : \"My updated private endpoint description\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePrivateEndpointDetails' description: Update details for a private endpoint. required: true /privateEndpoints/{privateEndpointId}/actions/changeCompartment: post: description: 'Moves a private endpoint to a different compartment within the same tenancy. For more information, see [Moving a Private Endpoint](/iaas/Content/ResourceManager/Tasks/move-private-endpoints.htm). ' operationId: ChangePrivateEndpointCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' responses: 204: description: Successfully accepted the request. The private endpoint will be moved to the specified compartment. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the private endpoint. tags: - ResourceManager x-example: "POST /20180917/privateEndpoints/<privateendpoint_OCID>/actions/changeCompartment\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" x-related-resource: '#/definitions/PrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePrivateEndpointCompartmentDetails' description: Defines the properties of changePrivateEndpointCompartment operation. required: true /privateEndpoints/{privateEndpointId}/reachableIp: get: description: 'Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint. For more information, see [Getting the Reachable IP Address for a Private Endpoint](/iaas/Content/ResourceManager/Tasks/get-private-endpoint-reachable-ip.htm). ' operationId: GetReachableIp parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/PrivateIpQueryParam' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: Successfully retrieved the IP address. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ReachableIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the alternative IP address of the private resource. tags: - ResourceManager x-example: 'GET /20180917/privateEndpoints/<privateendpoint_OCID>/reachableIp?privateIp=10.0.0.0 Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ReachableIp' /resourceDiscoveryServices: get: description: 'Returns a list of supported services for [Resource Discovery](/iaas/Content/ResourceManager/Concepts/resource-discovery.htm). For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). For more information, see [Listing Resource Discovery Services](/iaas/Content/ResourceManager/Tasks/list-discovery-services.htm). ' operationId: ListResourceDiscoveryServices parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: A list of supported Resource Discovery services. 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/ResourceDiscoveryServiceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists supported Resource Discovery services. tags: - ResourceManager x-example: 'GET /20180917/resourceDiscoveryServices Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' /stacks: get: description: 'Lists stacks according to the specified filter. For more information, see [Listing Stacks](/iaas/Content/ResourceManager/Tasks/list-stacks.htm). - If called using the compartment ID, returns all stacks in the specified compartment. - If called using the stack ID, returns the specified stack. (See also [GetStack](#/en/resourcemanager/latest/Stack/GetStack).) ' operationId: ListStacks parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/IdForStackQueryParam' - description: 'A filter that returns only those resources that match the specified lifecycle state. The state value is case-insensitive. For more information about stack lifecycle states, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Stack/lifecycleState' schema: type: string - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of stacks. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/StackSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Returns a stack or list of stacks. tags: - ResourceManager x-example: 'GET /20180917/stacks&compartmentId=<compartment_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a stack in the specified compartment. You can create a stack from a Terraform configuration. The Terraform configuration can be directly uploaded or referenced from a source code control system. You can also create a stack from an existing compartment, which generates a Terraform configuration. You can also upload the Terraform configuration from an Object Storage bucket. For more information, see [Creating a Stack](/iaas/Content/ResourceManager/Tasks/create-stack.htm). ' operationId: CreateStack parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: The newly created Stack object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. schema: type: string maxLength: 255 content: application/json: schema: $ref: '#/components/schemas/Stack' 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/DefaultError' summary: Creates a Stack. tags: - ResourceManager x-example: "Sample 1: Zip file using Terraform version 1.5.x\n\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"terraformVersion\": \"1.5.x\",\n \"displayName\": \"My Zip Configuration\",\n \"configSource\": {\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n },\n}\n\nSample 2: GitHub\n\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My GitHub Configuration\",\n \"configSource\": {\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"repositoryUrl\": \"https://github.com/user/repo.git\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n }\n}\n\nSample 3: Bucket\n\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Bucket Terraform Configuration\",\n \"configSource\": {\n \"configSourceType\": \"OBJECT_STORAGE_CONFIG_SOURCE\",\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n }\n}\n\n\nSample 4: Existing compartment (resource discovery)\n\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Compartment Configuration\",\n \"configSource\": {\n \"configSourceType\": \"COMPARTMENT_CONFIG_SOURCE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"region\": \"us-phoenix-1\"\n }\n}\n\nSample 5: Custom Terraform provider for existing compartment (resource discovery)\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Compartment Configuration with Custom Provider\",\n \"configSource\": {\n \"configSourceType\": \"COMPARTMENT_CONFIG_SOURCE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"region\": \"us-phoenix-1\"\n },\n \"customTerraformProvider\": {\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n }\n}\n\nSample 6: DevOps repository\nPOST /20180917/stacks\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"terraformVersion\": \"1.5.x\",\n \"displayName\": \"My DevOps Stack\",\n \"configSource\": {\n \"configSourceType\": \"DEVOPS_CONFIG_SOURCE\",\n \"projectId\": \"ocid1.devopsproject.oc1..<unique_ID>\",\n \"repositoryId\": \"ocid1.devopsrepository.oc1..<unique_ID>\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStackDetails' description: The properties for creating a stack. required: true /stacks/{stackId}: delete: description: 'Deletes the specified stack. For more information, see [Deleting a Stack](/iaas/Content/ResourceManager/Tasks/delete-stack.htm). ' operationId: DeleteStack parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 204: description: Success headers: opc-request-id: description: Unique identifier for the request. schema: type: string 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' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a stack tags: - ResourceManager x-example: 'DELETE /20180917/stacks/<stack_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' get: description: 'Gets the specified stack. For more information, see [Getting a Stack''s Details](/iaas/Content/ResourceManager/Tasks/get-stack.htm). ' operationId: GetStack parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 200: description: Returns the Stack object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Stack' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a stack by ID. tags: - ResourceManager x-example: 'GET /20180917/stacks/<stack_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified stack. Use `UpdateStack` when you update your Terraform configuration and want your changes to be reflected in the execution plan. For more information, see [Updating a Stack](/iaas/Content/ResourceManager/Tasks/update-stack.htm). ' operationId: UpdateStack parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 200: description: Returns the updated stack. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Stack' 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/DefaultError' summary: Updates the specified stack object. tags: - ResourceManager x-example: "PUT /20180917/stacks/<stack_OCID>\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"terraformVersion\": \"1.5.x\",\n \"displayName\": \"My Zip Configuration\",\n \"configSource\": {\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n },\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateStackDetails' description: 'The details for updating a stack. ' required: true /stacks/{stackId}/actions/changeCompartment: post: description: 'Moves a stack (and its associated jobs) into a different compartment within the same tenancy. For more information, see [Moving a Stack](/iaas/Content/ResourceManager/Tasks/change-compartment-stack.htm). ' operationId: ChangeStackCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 202: description: Returns no content. Header contains work request id. headers: opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. 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/DefaultError' summary: Moves a Stack and it's associated Jobs into a different compartment. When provided, If-Match is checked against ETag values of the Stack. tags: - ResourceManager x-example: "POST /20180917/stacks/<stack_OCID>/actions/changeCompartment\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-related-resource: '#/definitions/Stack' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeStackCompartmentDetails' description: Defines the properties of changeStackCompartment operation. required: true /stacks/{stackId}/actions/detectDrift: post: description: 'Checks drift status for the specified stack. For more information, see [Detecting Drift](/iaas/Content/ResourceManager/Tasks/detect-drift.htm). ' operationId: DetectStackDrift parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 202: description: Returns no content. Header contains work request id. headers: opc-request-id: description: Unique identifier for the request. schema: type: string opc-work-request-id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. 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' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: 'Checks drift status for the specified stack. ' tags: - ResourceManager x-example: 'POST /20180917/stacks/<stack_OCID>/actions/detectDrift Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetectStackDriftDetails' description: The details for detecting drift in a stack /stacks/{stackId}/actions/listResourceDriftDetails: post: description: 'Lists drift status details for each resource defined in the specified stack. The drift status details for a given resource indicate differences, if any, between the actual state and the expected (defined) state for that resource. The drift status details correspond to the specified work request (`workRequestId`). If no work request is specified, then the drift status details correspond to the latest completed work request for the stack. For more information, see [Listing Drift Status](/iaas/Content/ResourceManager/Tasks/list-drift.htm). ' operationId: ListStackResourceDriftDetails parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - description: 'A filter that returns only resources that match the given drift status. The value is case-insensitive. ' in: query name: resourceDriftStatus required: false style: form explode: true schema: type: array items: type: string x-obmcs-enumref: '#/definitions/StackResourceDriftSummary/resourceDriftStatus' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: Drift status details for resources in the stack. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StackResourceDriftCollection' 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: Lists drift status details for each resource defined in the specified stack. tags: - ResourceManager x-example: 'POST /20180917/stacks/<stack_OCID>/actions/listResourceDriftDetails Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/StackResourceDriftSummary' /stacks/{stackId}/associatedResources: get: description: 'Gets the list of resources associated with the specified stack. For more information, see [Listing Stack Resources](/iaas/Content/ResourceManager/Tasks/list-stack-resources.htm). ' operationId: ListStackAssociatedResources parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' - $ref: '#/components/parameters/TerraformResourceTypeQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of associated resources. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssociatedResourcesCollection' 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/DefaultError' summary: Gets the list of resources associated with the specified stack. tags: - ResourceManager x-example: 'Sample 1: Gets all the resources associated with the given stack GET /20180917/stacks/<stack_OCID>/associatedResource Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: Gets compute instances (`oci_core_instance`) associated with the given stack GET /20180917/stacks/<stack_OCID>/associatedResource?resourceType=oci_core_instance Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AssociatedResourceSummary' /stacks/{stackId}/tfConfig: get: description: 'Returns the Terraform configuration file for the specified stack in zip format. Returns an error if no zip file is found. For more information, see [Getting a Stack Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-stack-tf-config.htm). ' operationId: GetStackTfConfig parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 200: description: Terraform configuration zip file. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/zip: schema: format: binary type: string 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/DefaultError' summary: Gets the stack's zipped Terraform configuration tags: - ResourceManager x-example: 'GET /20180917/stacks/<stack_OCID>/tfConfig Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' /stacks/{stackId}/tfState: get: description: 'Returns the Terraform state for the specified stack. For more information, see [Getting a Stack State File](/iaas/Content/ResourceManager/Tasks/get-stack-tf-state.htm). ' operationId: GetStackTfState parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/StackIdPathParam' responses: 200: description: A Terraform state. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/octet-stream: schema: format: binary type: string 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/DefaultError' summary: Get Terraform state of the specified stack. tags: - ResourceManager x-example: 'GET /20180917/stacks/<stack_OCID>/tfState Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' /templateCategories: get: description: 'Lists template categories. For more information, see [Listing Template Categories](/iaas/Content/ResourceManager/Tasks/list-template-categories.htm). ' operationId: ListTemplateCategories parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: A list of template categories. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplateCategorySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists template categories. tags: - ResourceManager x-example: 'GET /20180917/templateCategories Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/TemplateCategorySummary' /templates: get: description: 'Lists templates according to the specified filter. The attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified. For more information, see [Listing Templates](/iaas/Content/ResourceManager/Tasks/list-template.htm). ' operationId: ListTemplates parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TemplateCategoryIdQueryParam' - $ref: '#/components/parameters/TemplateIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A list of templates. headers: opc-next-page: description: 'Retrieves the next page of paginated list items. If the `opc-next-page` header appears in the response, additional pages of results remain. To receive the next page, include the header value in the `page` param. If the `opc-next-page` header does not appear in the response, there are no more list items to get. For more information about list pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/TemplateSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists templates according to the specified filter. tags: - ResourceManager x-example: 'Sample 1: Quickstart templates GET /20180917/templates&compartmentId=<compartment_OCID>&templateCategoryId=0 Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> Sample 2: Private templates GET /20180917/templates&compartmentId=<compartment_OCID>&templateCategoryId=3 Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Template' post: description: 'Creates a private template in the specified compartment. For more information, see [Creating a Private Template](/iaas/Content/ResourceManager/Tasks/create-template.htm). ' operationId: CreateTemplate parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: The newly created template. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Template' 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/DefaultError' summary: Creates a private template in the specified compartment. tags: - ResourceManager x-example: "POST /20180917/templates\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Template\",\n \"description\": \"My Template Description\",\n \"longDescription\": \"My Template Long Description\"\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemplateDetails' description: The configuration details for creating a template. required: true /templates/{templateId}: delete: description: 'Deletes the specified template. For more information, see [Deleting a Private Template](/iaas/Content/ResourceManager/Tasks/delete-template.htm). ' operationId: DeleteTemplate parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 204: description: The template was deleted. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Deletes the specified template. tags: - ResourceManager x-related-resource: '#/definitions/Template' get: description: 'Gets the specified template. For more information, see [Getting a Private Template''s Details](/iaas/Content/ResourceManager/Tasks/get-template.htm). ' operationId: GetTemplate parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 200: description: Returns the template. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Template' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the specified template. tags: - ResourceManager x-example: 'GET /20180917/templates/ Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the specified template. For more information, see [Updating a Private Template](/iaas/Content/ResourceManager/Tasks/update-template.htm). ' operationId: UpdateTemplate parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 200: description: Returns the updated template object. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: Unique identifier for the request. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Template' 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/DefaultError' summary: Updates the specified template. tags: - ResourceManager x-example: "PUT /20180917/templates?templateId=<template_OCID>\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Template Display Name\",\n \"description\": \"Brief description of the template\",\n \"longDescription\": \"Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded..\",\n \"logoFileBase64Encoded\": \"binary string\",\n \"zipFileBase64Encoded\": \"binary string\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTemplateDetails' description: 'The details for updating a template. ' required: true /templates/{templateId}/actions/changeCompartment: post: description: 'Moves a template into a different compartment within the same tenancy. For more information, see [Moving a Private Template](/iaas/Content/ResourceManager/Tasks/change-compartment-template.htm). ' operationId: ChangeTemplateCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 204: description: The request to move the template to a different compartment. headers: opc-request-id: description: Unique identifier for the request. 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/DefaultError' summary: Moves a template into a different compartment. When provided, If-Match is checked against ETag values of the Template. tags: - ResourceManager x-example: "POST /20180917/templates/<template_OCID>/actions/changeCompartment\nHost: resourcemanager.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" x-related-resource: '#/definitions/Template' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTemplateCompartmentDetails' description: The details for moving a template to a different compartment. required: true /templates/{templateId}/logo: get: description: 'Returns the Terraform logo file in .logo format for the specified template. Returns an error if no logo file is found. For more information, see [Getting a Private Template''s Logo](/iaas/Content/ResourceManager/Tasks/get-template-logo.htm). ' operationId: GetTemplateLogo parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 200: description: Terraform logo file. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: image/png: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the template's logo file tags: - ResourceManager x-related-resource: '#/definitions/Template' /templates/{templateId}/tfConfig: get: description: 'Returns the Terraform configuration file in zip format for the specified template. Returns an error if no zip file is found. For more information, see [Getting a Private Template''s Terraform Configuration](/iaas/Content/ResourceManager/Tasks/get-template-tf-config.htm). ' operationId: GetTemplateTfConfig parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/TemplateIdPathParam' responses: 200: description: Terraform configuration zip file. headers: opc-request-id: description: Unique identifier for the request. schema: type: string content: application/zip: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the template's zipped Terraform configuration tags: - ResourceManager x-related-resource: '#/definitions/Template' /terraformVersions: get: description: 'Returns a list of supported Terraform versions for use with stacks. For more information, see [Listing Terraform Versions](/iaas/Content/ResourceManager/Tasks/list-tf-versions.htm). ' operationId: ListTerraformVersions parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: A list of supported Terraform versions. 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/TerraformVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists supported Terraform versions. tags: - ResourceManager x-example: 'GET /20180917/terraformVersions Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Stack' /workRequests: get: description: 'Lists the work requests in the specified compartment or for the specified resource. For more information, see [Listing Work Requests](/iaas/Content/ResourceManager/Tasks/list-work-request.htm). ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/RequiredCompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: List of work requests 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 there might be additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For more information about list pagination, 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/WorkRequestSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work requests tags: - ResourceManager x-example: 'GET /20180917/workRequests&compartmentId=<compartment_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: 'Returns the specified work request. For more information, see [Getting a Work Request''s Details](/iaas/Content/ResourceManager/Tasks/get-work-request.htm). ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: Work request 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/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Work Request tags: - ResourceManager x-example: 'GET /20180917/workRequests/<workrequest_OCID> Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a paginated list of errors for the specified work request. For more information, see [Listing Errors for a Work Request](/iaas/Content/ResourceManager/Tasks/list-work-request-errors.htm). ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: List of work request errors. 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 there might be additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For more information about list pagination, 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/WorkRequestError' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request errors tags: - ResourceManager x-example: 'GET /20180917/workRequests/<workrequest_OCID>/errors Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: 'Returns a paginated list of logs for the specified work request. For more information, see [Listing Logs for a Work Request](/iaas/Content/ResourceManager/Tasks/list-work-request-logs.htm). ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: List of work request logs. 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 there might be additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For more information about list pagination, 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/WorkRequestLogEntry' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request logs tags: - ResourceManager x-example: 'GET /20180917/workRequests/<workrequest_OCID>/logs Host: resourcemanager.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/WorkRequest' components: parameters: RequiredCompartmentIdQueryParam: description: 'A filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: compartmentId required: true schema: type: string StackIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack. in: path name: stackId required: true schema: type: string PrivateEndpointIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. ' in: query name: privateEndpointId required: false schema: type: string TemplateCategoryIdQueryParam: description: 'Unique identifier for the template category. Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created. ' in: query name: templateCategoryId required: false schema: type: string OpcRetryTokenHeaderParam: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. 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 required: false schema: type: string IfMatchHeaderParam: 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 IdForConfigurationSourceProviderQueryParam: description: 'A filter to return only configuration source providers that match the provided [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: configurationSourceProviderId required: false schema: type: string SortOrderQueryParam: description: 'The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`). ' in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC IdForJobQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to query for jobs. ' in: query name: id required: false schema: type: string IsForcedQueryParam: description: 'Indicates whether a forced cancellation is requested for the job while it was running. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources. ' in: query name: isForced required: false schema: type: boolean default: false SortByQueryParam: description: 'The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME FilterByDisplayNameQueryParam: description: 'A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation. ' in: query name: displayName required: false schema: type: string maxLength: 255 TemplateIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the template. in: path name: templateId required: true schema: type: string LogTimestampLessThanOrEqualToQueryParam: description: 'Time stamp specifying the upper time limit for which logs are returned in a query. Format is defined by RFC3339. Example: `2020-02-01T12:00:00.000Z` ' in: query name: timestampLessThanOrEqualTo required: false schema: type: string format: date-time WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. in: path name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 TfPlanFormatQueryParam: description: 'The output format of the Terraform plan. ' in: query name: tfPlanFormat required: false schema: type: string enum: - BINARY - JSON default: BINARY PrivateIpQueryParam: description: 'The IP address of the resource in the private subnet. ' in: query name: privateIp required: true schema: type: string TemplateIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the template. in: query name: templateId required: false schema: type: string PrivateEndpointIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. in: path name: privateEndpointId required: true schema: type: string PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string maxLength: 512 minLength: 1 JobIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. in: path name: jobId required: true schema: type: string WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. in: query name: workRequestId required: false schema: type: string StackIdQueryParam: description: 'The stack [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to filter. ' in: query name: stackId required: false schema: type: string TerraformResourceTypeQueryParam: description: 'A filter to return only specified resource types. For more information about resource types supported for the Oracle Cloud Infrastructure [OCI] provider, see [Oracle Cloud Infrastructure Provider](https://registry.terraform.io/providers/oracle/oci/latest/docs). ' in: query name: terraformResourceType required: false schema: type: string IdForStackQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) on which to query for a stack. ' in: query name: id required: false schema: type: string ConfigurationSourceProviderIdPathParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. ' in: path name: configurationSourceProviderId required: true schema: type: string FilterByVcnIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. in: query name: vcnId required: false schema: type: string CompartmentIdQueryParam: description: 'A filter to return only resources that exist in the compartment, identified by [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: compartmentId required: false schema: type: string LogTimestampGreaterThanOrEqualToQueryParam: description: 'Time stamp specifying the lower time limit for which logs are returned in a query. Format is defined by RFC3339. Example: `2020-01-01T12:00:00.000Z` ' in: query name: timestampGreaterThanOrEqualTo required: false schema: type: string format: date-time PaginationLimitQueryParam: description: 'The number of items returned in a paginated `List` call. For information about pagination, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer maximum: 1000 minimum: 1 ResourceIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. in: query name: resourceId required: false schema: type: string maxLength: 255 minLength: 1 OpcRequestIdHeaderParam: 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 required: false schema: type: string FilterByConfigSourceProviderTypeQueryParam: description: 'A filter to return only configuration source providers of the specified type (GitHub or GitLab). ' in: query name: configSourceProviderType required: false schema: type: string schemas: Error: description: Error that occurs during the execution of a job. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. For more information, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message Stack: description: 'The properties that define a stack. A stack is the collection of Oracle Cloud Infrastructure resources corresponding to a given Terraform configuration. For instructions on managing stacks, see [Managing Stacks](/iaas/Content/ResourceManager/Tasks/stacks.htm). For more information about stacks, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__stackdefinition). ' properties: compartmentId: description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the compartment where the stack is located. type: string configSource: $ref: '#/components/schemas/ConfigSource' customTerraformProvider: $ref: '#/components/schemas/CustomTerraformProvider' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the stack. type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the stack. type: string isThirdPartyProviderExperienceEnabled: description: 'When `true`, the stack sources third-party Terraform providers from [Terraform Registry](https://registry.terraform.io/browse/providers) and allows [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). For more information about stack sourcing of third-party Terraform providers, see [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). ' type: boolean lifecycleState: description: 'The current lifecycle state of the stack. For more information about stack lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). ' enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED type: string stackDriftStatus: description: 'Drift status of the stack. Drift refers to differences between the actual (current) state of the stack and the expected (defined) state of the stack. ' enum: - NOT_CHECKED - IN_SYNC - DRIFTED 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 terraformVersion: description: 'The version of Terraform specified for the stack. Example: `1.5.x` ' maxLength: 255 type: string timeCreated: description: 'The date and time at which the stack was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeDriftLastChecked: description: 'The date and time when the drift detection was last executed. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string variables: additionalProperties: type: string description: 'Terraform variables associated with this resource. Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: `{"CompartmentId": "compartment-id-value"}` ' maxProperties: 250 type: object type: object x-example: "{\n \"id\": \"ocid1.ormstackoc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Stack Display Name\",\n \"description\": \"Brief description of the stack.\",\n \"timeCreated\": \"2018-10-02T19:18:44.437Z\",\n \"lifecycleState\": \"CREATING\"\n \"configSource\": {\n \"configSourceType\": \"ZIP_UPLOAD\"\n \"workingDirectory\": \"<file_path_to_directory>\"\n },\n \"customTerraformProvider\" : {\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n },\n \"isThirdPartyProviderExperienceEnabled\": true,\n \"variables\": {\n \"additionalProp1\": \"myVariable01\"\n \"additionalProp2\": \"myVariable02\"\n },\n \"terraformVersion\": \"1.5.x\",\n \"stackDriftStatus\": \"DRIFTED\",\n \"timeDriftLastChecked\": \"2019-10-02T19:18:44.437Z\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n },\n}\n" JobOutputSummary: description: 'Terraform output associated with a job. ' properties: description: description: Description of the output. type: string isSensitive: description: When `true`, output is sensitive. type: boolean outputName: description: Name of the output. type: string outputType: description: Output resource type. type: string outputValue: description: Value of the Terraform output. type: string x-example: "{\n name: \"BootVolumeIDs\",\n type: \"list\"\n value: \"[\\\"ocid1.bootvolume.oc1.phx.abyhqljrglzsejlhn5j6ycmfvufo7zmxtsc27lp2lcjeuv7jonod7tr7f6ea\\\"]\"\n sensitive: false\n}\n" UpdateConfigurationSourceProviderDetails: description: 'Update details for a configuration source provider. ' discriminator: propertyName: configSourceProviderType properties: configSourceProviderType: description: 'The type of configuration source provider. The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. For Bitbucket Cloud, update requests must provide Atlassian account `email` and `secretId` containing an API token. The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. ' type: string x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the configuration source provider. Avoid entering confidential information. type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object privateServerConfigDetails: $ref: '#/components/schemas/PrivateServerConfigDetails' type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Configuration Source Provider\",\n \"description\": \"Example Git Source\",\n \"configSourceProviderType\": \"GITLAB_ACCESS_TOKEN\",\n \"apiEndpoint\": \"https://gitlab.com\",\n \"accessToken\": \"<token>\",\n \"privateServerConfigDetails\": {\n \"privateEndpointId\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"certificateId\": \"ocid1.certificate.oc1..<unique_ID>\"\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" ConfigurationSourceProvider: description: 'The properties that define a configuration source provider. For more information, see [Managing Configuration Source Providers](/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm). ' discriminator: propertyName: configSourceProviderType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the configuration source provider is located. type: string configSourceProviderType: description: 'The type of configuration source provider. The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. ' enum: - BITBUCKET_CLOUD_ACCESS_TOKEN - BITBUCKET_SERVER_ACCESS_TOKEN - GITLAB_ACCESS_TOKEN - GITHUB_ACCESS_TOKEN type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the configuration source provider. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string email: description: Atlassian account email used for Bitbucket Cloud API token authentication. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. type: string isMigrationRequired: description: 'Indicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated. ' type: boolean lifecycleState: description: 'The current lifecycle state of the configuration source provider. For more information about configuration source provider lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__CSPStates). ' enum: - ACTIVE type: string privateServerConfigDetails: $ref: '#/components/schemas/PrivateServerConfigDetails' secretId: description: Secret ocid which is used to authorize the user. 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 date and time when the configuration source provider was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string username: description: Username which is used to authorize the user. type: string required: - configSourceProviderType type: object x-example: "{\n \"id\": \"ocid1.configSourceProvider.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Configuration Source Provider\",\n \"description\": \"Example Git Source\",\n \"timeCreated\": \"2019-10-02T19:18:44.437Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"configSourceProviderType\": \"GITLAB_ACCESS_TOKEN\",\n \"apiEndpoint\": \"https://gitlab.com\",\n \"privateServerConfigDetails\": {\n \"privateEndpointId\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"sslCertificateId\": \"ocid1.certificate.oc1..<unique_ID>\"\n },\n\n \"email\": \"myuser@example.com\",\n \"secretId\": \"ocid1.secret.oc1..<unique_ID>\",\n\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" CreateStackDetails: description: 'Creation details for a stack. ' properties: compartmentId: description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) of the compartment in which the stack resides. type: string configSource: $ref: '#/components/schemas/CreateConfigSourceDetails' customTerraformProvider: $ref: '#/components/schemas/CustomTerraformProvider' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags associated with this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the stack. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object terraformVersion: description: 'The version of Terraform to use with the stack. Example: `1.5.x` ' maxLength: 255 type: string variables: additionalProperties: type: string description: 'Terraform variables associated with this resource. Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: `{"CompartmentId": "compartment-id-value"}` ' maxProperties: 250 type: object required: - compartmentId - configSource type: object x-example: "Sample 1: Zip file using Terraform version 1.5.x\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"terraformVersion\": \"1.5.x\",\n \"displayName\": \"My Zip Configuration\",\n \"configSource\": {\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n },\n}\n\nSample 2: GitHub\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My GitHub Configuration\",\n \"configSource\": {\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"repositoryUrl\": \"https://github.com/user/repo.git\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n }\n}\n\nSample 3: Bucket\n\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Bucket Terraform Configuration\",\n \"configSource\": {\n \"configSourceType\": \"OBJECT_STORAGE_CONFIG_SOURCE\",\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n }\n}\n\n\nSample 4: Existing compartment (resource discovery)\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Compartment Configuration\",\n \"configSource\": {\n \"configSourceType\": \"COMPARTMENT_CONFIG_SOURCE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"region\": \"us-phoenix-1\"\n }\n}\n\nSample 5: Custom Terraform provider for existing compartment (resource discovery)\n {\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Compartment Configuration with Custom Provider\",\n \"configSource\": {\n \"configSourceType\": \"COMPARTMENT_CONFIG_SOURCE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"region\": \"us-phoenix-1\"\n },\n \"customTerraformProvider\": {\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n }\n}\n\nSample 6: DevOps repository\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"terraformVersion\": \"1.5.x\",\n \"displayName\": \"My DevOps Stack\",\n \"configSource\": {\n \"configSourceType\": \"DEVOPS_CONFIG_SOURCE\",\n \"projectId\": \"ocid1.devopsproject.oc1..<unique_ID>\",\n \"repositoryId\": \"ocid1.devopsrepository.oc1..<unique_ID>\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n }\n}\n" UpdateStackDetails: description: 'Update details for a stack. ' properties: configSource: $ref: '#/components/schemas/UpdateConfigSourceDetails' customTerraformProvider: $ref: '#/components/schemas/CustomTerraformProvider' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the stack. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isThirdPartyProviderExperienceEnabled: description: 'When `true`, changes the stack''s sourcing of third-party Terraform providers to [Terraform Registry](https://registry.terraform.io/browse/providers) and allows [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). Applies to older stacks. Once set to `true`, cannot be reverted. For more information about stack sourcing of third-party Terraform providers, see [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). ' type: boolean terraformVersion: description: 'The version of Terraform to use with the stack. Example: `1.5.x` ' maxLength: 255 type: string variables: additionalProperties: type: string description: 'Terraform variables associated with this resource. The maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: `{"CompartmentId": "compartment-id-value"}` ' maxProperties: 250 type: object type: object x-example: "{\n \"displayName\": \"Stack Display Name\",\n \"description\": \"Brief description of the stack.\",\n \"configSource\": {\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n },\n \"customTerraformProvider\" : {\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n },\n \"isThirdPartyProviderExperienceEnabled\": true,\n \"variables\": {\n \"additionalProp1\": \"myVariable01\",\n \"additionalProp2\": \"myVariable02\"\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" JobOperationDetails: description: 'Job details that are specific to the operation type. ' discriminator: propertyName: operation properties: operation: description: Terraform-specific operation to execute. type: string x-obmcs-enumref: '#/definitions/Job/operation' required: - operation type: object PrivateEndpointCollection: description: 'A list of private endpoints that match filter criteria, if any. Results contain `PrivateEndpointSummary` objects. ' properties: items: description: A list of private endpoints. items: $ref: '#/components/schemas/PrivateEndpointSummary' type: array required: - items type: object JobSummary: description: Summary information for a job. properties: applyJobPlanResolution: $ref: '#/components/schemas/ApplyJobPlanResolution' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the stack of the associated job resides. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string jobOperationDetails: $ref: '#/components/schemas/JobOperationDetailsSummary' lifecycleState: description: 'Current state of the specified job. For more information about job lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__JobStates). ' type: string x-obmcs-enumref: '#/definitions/Job/lifecycleState' operation: description: The type of job executing type: string x-obmcs-enumref: '#/definitions/Job/operation' resolvedPlanJobId: description: 'Deprecated. Use the property `executionPlanJobId` in `jobOperationDetails` instead. The plan job [OCID](/iaas/Content/General/Concepts/identifiers.htm) that was used (if this was an apply job and was not auto-approved). ' type: string stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the specified job. 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 date and time the job was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time the job succeeded or failed. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string type: object x-example: "{\n \"id\": \"ocid1.ormjob.oc1..<unique_ID>\",\n \"stackId\": \"ocid1.ormstack.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Job Display Name\",\n \"operation\": \"APPLY\",\n \"jobOperationDetails\": {\n \"operation\": \"APPLY\",\n \"executionPlanStrategy\": \"FROM_PLAN_JOB_ID\",\n \"executionPlanJobId\": \"ocid1.ormjob.oc1..<unique_ID>\"\n },\n \"applyJobPlanResolution\": {\n \"planJobId\": \"ocid1.ormjob.oc1..<unique_ID>\"\n },\n \"timeCreated\": \"2018-10-02T19:18:44.437Z\",\n \"timeFinished\": \"2018-10-02T19:18:44.439Z\",\n \"lifecycleState\": \"SUCCEEDED\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" UpdateConfigSourceDetails: description: 'Update details for a configuration source. ' discriminator: propertyName: configSourceType properties: configSourceType: description: 'Specifies the `configSourceType` for uploading the Terraform configuration. ' type: string x-obmcs-enumref: '#/definitions/ConfigSource/configSourceType' workingDirectory: description: 'File path to the directory to use for running Terraform. If not specified, the root directory is used. Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. For more information about required and recommended file structure, see [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). ' type: string required: - configSourceType x-example: "Sample 1: Local Terraform configuration (zip file)\n\n{\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"branchName\": \"MyBranch\"\n}\n\nSample 2: Remote Terraform configuration (Git)\n\n{\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n}\n" UpdatePrivateEndpointDetails: description: 'Update details for a private endpoint. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the private endpoint. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. ' items: type: string maxItems: 5 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isUsedWithConfigurationSourceProvider: description: When `true`, allows the private endpoint to be used with a configuration source provider. type: boolean nsgIdList: description: 'The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) for the private endpoint. Order does not matter. ' items: type: string type: array subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. type: string type: object x-example: "{\n \"displayName\": \"My Private Endpoint\",\n \"description\": \"Example Private Endpoint\",\n \"vcnId\": \"ocid1.vcn.oc1.phx.<vcn_OCID>\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.<subnet_OCID>\",\n \"dnsZones\": [\"abc.oraclevcn.com\", \"def.oraclevcn.com\"],\n \"nsgIdList\": [\"ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>\",\"ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>\"],\n \"isUsedWithConfigurationSourceProvider\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n },\n \"securityAttributes\": {\n \"oracle-zpr\": {\n \"MaxEgressCount\": {\n \"mode\": \"enforce\",\n \"value\": \"45\"\n }\n }\n }\n}\n" WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) of the compartment that contains the work request. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) identifying this work request. type: string operationType: description: The asynchronous operation tracked by this work request. type: string x-obmcs-enumref: '#/definitions/WorkRequest/operationType' percentComplete: description: Percentage of the work request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the specified work request. type: string x-obmcs-enumref: '#/definitions/WorkRequest/status' timeAccepted: description: 'The date and time when the work request was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time when the work request reached a terminal state (FAILED or SUCCEEDED). Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time when the work request transitioned from ACCEPTED to IN_PROGRESS. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted x-example: "{\n \"operationType\": \"CREATE_STACK_FROM_COMPARTMENT\",\n \"status\": \"ACCEPTED\",\n \"id\": \"ocid1.ormworkrequest.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"resources\": [\n {\n \"actionType\": \"IN_PROGRESS\",\n \"entityType\": \"ormstack\",\n \"identifier\": \"ocid1.ormstack.oci..<unique_ID>\",\n \"entityUri\": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>\"\n }\n ],\n \"percentComplete\": 0,\n \"timeAccepted\": \"2020-01-25T21:10:29.600Z\"\n}\n" TemplateSummaryCollection: description: 'Results of a `ListTemplates` operation. ' properties: items: description: A list of template summaries. items: $ref: '#/components/schemas/TemplateSummary' type: array required: - items type: object ConfigSourceRecord: description: 'Information about the Terraform configuration. ' discriminator: propertyName: configSourceRecordType properties: configSourceRecordType: description: 'The type of configuration source to use for the Terraform configuration. ' enum: - BITBUCKET_CLOUD_CONFIG_SOURCE - BITBUCKET_SERVER_CONFIG_SOURCE - COMPARTMENT_CONFIG_SOURCE - DEVOPS_CONFIG_SOURCE - GIT_CONFIG_SOURCE - OBJECT_STORAGE_CONFIG_SOURCE - ZIP_UPLOAD type: string required: - configSourceRecordType type: object x-example: "Sample 1: Local Terraform configuration (zip file)\n\n{\n \"configSourceRecordType\": \"ZIP_UPLOAD\"\n}\n\nSample 2: Remote Terraform configuration (Git)\n\n{\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"repositoryUrl\": \"https://github.com/user/repo.git\",\n \"branchName\": \"MyBranch\",\n \"commitId\": \"2dc979a95e86abb211eda8515e1655dfa4275a00\"\n}\n" ChangeTemplateCompartmentDetails: description: 'Compartment details for moving a template. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the configuration source provider to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" CreateConfigSourceDetails: description: 'Creation details for a configuration source used with the stack. ' discriminator: propertyName: configSourceType properties: configSourceType: description: 'Specifies the `configSourceType` for uploading the Terraform configuration. ' type: string x-obmcs-enumref: '#/definitions/ConfigSource/configSourceType' workingDirectory: description: 'File path to the directory to use for running Terraform. If not specified, the root directory is used. Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. For more information about required and recommended file structure, see [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). ' type: string required: - configSourceType TemplateConfigSource: description: 'Information about the Template. ' discriminator: propertyName: templateConfigSourceType properties: templateConfigSourceType: description: 'The type of configuration source to use for the template configuration. ' enum: - ZIP_UPLOAD type: string required: - templateConfigSourceType type: object x-example: "Sample 1: Directly uploaded Template zip file\n{\n \"templateConfigSourceType\": \"ZIP_UPLOAD\",\n}\n" StackResourceDriftSummary: description: 'Drift status details for the indicated resource and stack. Includes actual and expected (defined) properties. ' properties: actualProperties: additionalProperties: type: string description: 'Actual values of properties that the stack defines for the indicated resource. Each property and value is provided as a key-value pair. The following example shows actual values for the resource''s display name and server type: `{"display_name": "tf-default-dhcp-options-new", "options.0.server_type": "VcnLocalPlusInternet"}` ' type: object compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the stack is located. type: string expectedProperties: additionalProperties: type: string description: 'Expected values of properties that the stack defines for the indicated resource. Each property and value is provided as a key-value pair. The following example shows expected (defined) values for the resource''s display name and server type: `{"display_name": "tf-default-dhcp-options", "options.0.server_type": "VcnLocalPlusInternet"}` ' type: object resourceDriftStatus: description: 'The drift status of the resource. A drift status value indicates whether or not the actual state of the resource differs from the expected (defined) state for that resource. ' enum: - NOT_CHECKED - IN_SYNC - MODIFIED - DELETED type: string resourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource provisioned by Terraform. maxLength: 255 type: string resourceName: description: The name of the resource as defined in the stack. maxLength: 255 type: string resourceType: description: 'The provider resource type. Must be supported by the [Oracle Cloud Infrastructure provider](https://www.terraform.io/docs/providers/oci/index.html). Example: `oci_core_instance` ' maxLength: 255 type: string stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack. type: string timeDriftChecked: description: 'The date and time when the drift detection was executed. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string type: object x-example: "{\n \"stackId\": \"ocid1.ormstackoc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"resourceName\": \"oci_core_default_dhcp_options.tf-default-dhcp-options\",\n \"resourceId\": \"ocid1.dhcpoptions.oc1..<unique_ID>\",\n \"resourceType\": \"oci_core_dhcp_options\",\n \"resourceDriftStatus\": \"MODIFIED\",\n \"actualProperties\":\n \"{\n \"display_name\": \"tf-default-dhcp-options-new\",\n \"id\": \"ocid1.dhcpoptions.oc1..<unique_ID>\",\n \"options.0.server_type\": \"VcnLocalPlusInternet\",\n \"state\": \"AVAILABLE\",\n \"time_created\": \"2019-01-08 23:10:28.441 +0000 UTC\"\n }\",\n \"expectedProperties\":\n \"{\n \"display_name\": \"tf-default-dhcp-options\",\n \"id\": \"ocid1.dhcpoptions.oc1.phx..<unique_ID>\",\n \"options.0.server_type\": \"VcnLocalPlusInternet\",\n \"state\": \"AVAILABLE\",\n \"time_created\": \"2019-01-08 23:10:28.441 +0000 UTC\"\n }\",\n \"timeDriftChecked\": \"2019-10-02T19:18:44.437Z\",\n}\n" StackSummary: description: 'Summary information for a stack. ' properties: compartmentId: description: Unique identifier of the compartment in which the stack resides. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: General description of the stack. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier of the specified stack. type: string lifecycleState: description: 'The current lifecycle state of the stack. For more information about stack lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__StackStates). ' type: string x-obmcs-enumref: '#/definitions/Stack/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 terraformVersion: description: 'The version of Terraform specified for the stack. Example: `1.5.x` ' maxLength: 255 type: string timeCreated: description: 'The date and time when the stack was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string type: object x-example: "{\n \"id\": \"ocid1.ormstack.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Stack Display Name\",\n \"description\": \"Brief description of the stack.\",\n \"timeCreated\": \"2018-10-02T19:18:44.437Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"terraformVersion\": \"1.5.x\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n },\n}\n" UpdateJobDetails: description: 'Update details for a job. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object x-example: "{\n \"displayName\": \"example_job\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" JobOperationDetailsSummary: description: 'A summary of job details that is specific to the operation type. ' discriminator: propertyName: operation properties: operation: description: Terraform-specific operation to execute. type: string x-obmcs-enumref: '#/definitions/Job/operation' required: - operation type: object ConfigSource: description: 'Information about the Terraform configuration. ' discriminator: propertyName: configSourceType properties: configSourceType: description: 'The type of configuration source to use for the Terraform configuration. ' enum: - BITBUCKET_CLOUD_CONFIG_SOURCE - BITBUCKET_SERVER_CONFIG_SOURCE - COMPARTMENT_CONFIG_SOURCE - DEVOPS_CONFIG_SOURCE - GIT_CONFIG_SOURCE - OBJECT_STORAGE_CONFIG_SOURCE - ZIP_UPLOAD type: string workingDirectory: description: 'File path to the directory to use for running Terraform. If not specified, the root directory is used. Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. For more information about required and recommended file structure, see [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). ' type: string required: - configSourceType type: object x-example: "Sample 1: Zip file\n\n{\n \"configSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n \"workingDirectory\": \"<file_path_to_directory>\"\n}\n\nSample 2: GitHub\n\n{\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"repositoryUrl\": \"https://github.com/user/repo.git\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n}\n\nSample 3: Bucket\n\n{\n \"configSourceType\": \"OBJECT_STORAGE_CONFIG_SOURCE\",\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n}\n\nSample 4: Existing compartment (resource discovery)\n\n{\n \"configSourceType\": \"COMPARTMENT_CONFIG_SOURCE\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"region\": \"us-phoenix-1\"\n}\n\nSample 5: DevOps repository\n\n{\n \"configSourceType\": \"DEVOPS_CONFIG_SOURCE\",\n \"projectId\": \"ocid1.devopsproject.oc1..<unique_ID>\",\n \"repositoryId\": \"ocid1.devopsrepository.oc1..<unique_ID>\",\n \"branchName\": \"MyBranch\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n}\n" ResourceDiscoveryServiceSummary: description: 'A service supported for use with [Resource Discovery](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). ' properties: discoveryScope: description: 'The scope of the service as used with Resource Discovery. This property determines the type of compartment OCID required: root compartment (`TENANCY`) or not (`COMPARTMENT`). For example, `identity` is at the root compartment scope while `database` is at the compartment scope. ' enum: - TENANCY - COMPARTMENT type: string name: description: 'A supported service. Example: `core` For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). ' maxLength: 255 type: string DetectStackDriftDetails: description: 'Details for detecting drift in a stack. ' properties: isProviderUpgradeRequired: default: false description: 'Specifies whether or not to upgrade provider versions. Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). ' type: boolean resourceAddresses: description: 'The list of resources in the specified stack to detect drift for. Each resource is identified by a resource address, which is a string derived from the resource type and name specified in the stack''s Terraform configuration plus an optional index. For example, the resource address for the fourth Compute instance with the name "test_instance" is oci_core_instance.test_instance[3]. For more details and examples of resource addresses, see the Terraform documentation at [Resource spec](https://www.terraform.io/docs/internals/resource-addressing.html#examples). ' items: maxLength: 512 type: string maxItems: 10 type: array uniqueItems: true type: object CancellationDetails: description: 'Cancellation details for a job. ' properties: isForced: description: 'Indicates whether a forced cancellation was requested for the job while it was running. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources. ' type: boolean type: object CreateJobOperationDetails: description: 'Job details that are specific to the operation type. ' discriminator: propertyName: operation properties: isProviderUpgradeRequired: default: false description: 'Specifies whether or not to upgrade provider versions. Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). ' type: boolean operation: description: Terraform-specific operation to execute. type: string x-obmcs-enumref: '#/definitions/Job/operation' required: - operation type: object StackResourceDriftCollection: description: 'Drift status details for resources in the stack. ' properties: items: description: Collection of drift status details for all resources defined in the stack. items: $ref: '#/components/schemas/StackResourceDriftSummary' type: array required: - items type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time when the log message was written. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string required: - message - timestamp x-example: "{\n \"message\": \"INFO 2020/10/22 17:04:55.414012 [INFO] discovering resources with data source 'oci_analytics_analytics_instances\",\n \"timestamp\": \"2020-10-22T17:04:55.423Z\"\n}\n" WorkRequest: description: The status of a work request. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this work request. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) identifying this work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CHANGE_STACK_COMPARTMENT - CREATE_STACK_FROM_COMPARTMENT - DRIFT_DETECTION - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT type: string percentComplete: description: The amount of work done relative to the total amount of work. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED type: string timeAccepted: description: 'The date and time when the work request was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time when the work request reached a terminal state (FAILED or SUCCEEDED). Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The date and time when the work request transitioned from ACCEPTED to IN_PROGRESS. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted x-example: "{\n \"operationType\": \"CREATE_STACK_FROM_COMPARTMENT\",\n \"status\": \"ACCEPTED\",\n \"id\": \"ocid1.ormworkrequest.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"resources\": [\n {\n \"actionType\": \"IN_PROGRESS\",\n \"entityType\": \"ormstack\",\n \"identifier\": \"ocid1.ormstack.oci..<unique_ID>\",\n \"entityUri\": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>\"\n }\n ],\n \"percentComplete\": 0,\n \"timeAccepted\": \"2020-01-25T21:10:29.600Z\"\n}\n" CreateConfigurationSourceProviderDetails: description: 'Creation details for a configuration source provider. ' discriminator: propertyName: configSourceProviderType properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the configuration source provider. ' type: string configSourceProviderType: description: 'The type of configuration source provider. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. For Bitbucket Cloud, create requests must provide Atlassian account `email` and `secretId` containing an API token. The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. ' type: string x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the configuration source provider. Avoid entering confidential information. type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object privateServerConfigDetails: $ref: '#/components/schemas/PrivateServerConfigDetails' required: - configSourceProviderType type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Configuration Source Provider\",\n \"description\": \"Example Git Source\",\n \"configSourceProviderType\": \"GITLAB_ACCESS_TOKEN\",\n \"apiEndpoint\": \"https://gitlab.com\",\n \"accessToken\": \"<token>\",\n \"privateServerConfigDetails\": {\n \"privateEndpointId\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"certificateId\": \"ocid1.certificate.oc1..<unique_ID>\"\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" AssociatedResourcesCollection: description: 'The list of associated resources for the indicated stack or job. ' properties: items: description: Collection of resources associated with a stack or job. items: $ref: '#/components/schemas/AssociatedResourceSummary' type: array required: - items type: object TemplateCategorySummary: description: 'Summary information for the template category. ' properties: displayName: description: The name of the template category. Not changeable. type: string id: description: 'Unique identifier for the template category. Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created. ' type: string x-example: "{\n \"id\": \"3\"\n \"displayName\": \"Private Template\",\n \"lifecycleState\": \"ACTIVE\"\n}\n" TerraformVersionSummary: description: 'A Terraform version supported for use with stacks. ' properties: isDefault: description: Indicates whether this Terraform version is used by default in [CreateStack](#/en/resourcemanager/latest/Stack/CreateStack). type: boolean name: description: 'A supported Terraform version. Example: `1.5.x` ' maxLength: 255 type: string WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS type: string entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string required: - actionType - entityType - identifier x-example: "{\n \"actionType\": \"IN_PROGRESS\",\n \"entityType\": \"ormstack\",\n \"identifier\": \"ocid1.ormstack.oci..<unique_ID>\",\n \"entityUri\": /latest/stacks/ocid1.ormstack.oc1..<unique_ID>\"\n}\n" UpdateTemplateConfigSourceDetails: description: 'Update details for a configuration source for a template. ' discriminator: propertyName: templateConfigSourceType properties: templateConfigSourceType: description: 'Specifies the `configSourceType` for uploading the Terraform configuration. ' type: string x-obmcs-enumref: '#/definitions/TemplateConfigSource/templateConfigSourceType' required: - templateConfigSourceType Template: description: 'The properties that define a template. A template is a pre-built Terraform configuration that provisions a set of resources used in a common scenario. ' properties: categoryId: description: 'Unique identifier for the category where the template is located. Possible values are `0` (Quick Starts), `1` (Service), `2` (Architecture), and `3` (Private). ' type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Brief description of the template. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the template. type: string isFreeTier: description: whether the template will work for free tier tenancy. type: boolean lifecycleState: description: 'The current lifecycle state of the template. ' enum: - ACTIVE type: string longDescription: description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. maxLength: 5000 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 templateConfigSource: $ref: '#/components/schemas/TemplateConfigSource' timeCreated: description: 'The date and time at which the template was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z` ' format: date-time type: string required: - id type: object x-example: "{\n \"id\": \"ocid1.template.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"categoryId\": \"1\",\n \"displayName\": \"Template Display Name\",\n \"description\": \"Brief description of the template.\",\n \"longDescription\": \"Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.\",\n \"timeCreated\": \"2020-10-02T19:18:44.437Z\",\n \"templateConfigSource\": {\n \"templateConfigSourceType\": \"ZIP_UPLOAD\"\n },\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" ApplyJobPlanResolution: description: 'Deprecated. Use the property `executionPlanStrategy` in `jobOperationDetails` instead. ' properties: isAutoApproved: description: 'Specifies whether to use the configuration directly, without reference to a Plan job. `True` if using the configuration directly. Note that it is not necessary for a Plan job to have run successfully. ' type: boolean isUseLatestJobId: description: 'Specifies whether to use the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the most recently run plan job. `True` if using the latest job [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a plan job that completed successfully. ' type: boolean planJobId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies the most recently executed plan job. ' type: string type: object ReachableIp: description: 'The reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint. Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint. ' properties: ipAddress: description: 'Reachable IP address associated with the private endpoint. ' type: string required: - ipAddress type: object x-example: "{\n \"ipAddress\": \"254.0.0.0\"\n}\n" WorkRequestError: description: An error encountered while executing a work request. 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 timestamp: description: 'The date and time when the error happened. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string required: - code - message - timestamp x-example: "{\n \"code\": \"500\",\n \"message\": \"WorkRequest Failed\",\n \"timestamp\": \"2020-05-19T09:39:13.238Z\"\n}\n" JobOutputsCollection: description: 'The list of outputs associated with a job. ' properties: items: description: A list of output summaries. items: $ref: '#/components/schemas/JobOutputSummary' type: array required: - items type: object TerraformVersionCollection: description: 'The list of Terraform versions supported for use with stacks. ' properties: items: description: Collection of supported Terraform versions. items: $ref: '#/components/schemas/TerraformVersionSummary' type: array required: - items type: object ChangePrivateEndpointCompartmentDetails: description: 'Compartment details for moving a private endpoint. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the private endpoint to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" ResourceDiscoveryServiceCollection: description: 'The list of [services supported for use with Resource Discovery](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services). ' properties: items: description: Collection of supported services for Resource Discovery. items: $ref: '#/components/schemas/ResourceDiscoveryServiceSummary' type: array required: - items type: object PrivateEndpointSummary: description: 'The summary metadata associated with the private endpoint. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the private endpoint. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'DNS zones to use for accessing private Git servers. For private Git server instructions, see [Private Git Server](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. ' items: type: string maxItems: 5 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. type: string isUsedWithConfigurationSourceProvider: description: When `true`, allows the private endpoint to be used with a configuration source provider. type: boolean lifecycleState: description: 'The current lifecycle state of the private endpoint. ' type: string x-obmcs-enumref: '#/definitions/PrivateEndpoint/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 date and time when the private endpoint was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. type: string required: - id - compartmentId - vcnId - displayName type: object x-example: "{\n \"id\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Private Endpoint\",\n \"description\": \"Example Private Endpoint\",\n \"vcnId\": \"ocid1.vcn.oc1..<unique_ID>\",\n \"timeCreated\": \"2019-10-02T19:18:44.437Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n },\n \"securityAttributes\": {\n \"oracle-zpr\": {\n \"MaxEgressCount\": {\n \"mode\": \"enforce\",\n \"value\": \"45\"\n }\n }\n }\n}\n" CustomTerraformProvider: description: 'Location information about custom Terraform providers for a stack. For more information, see [Using Custom Providers with a Stack](/iaas/Content/ResourceManager/Tasks/update-stack-custom-providers.htm). Note: Older stacks must be explicitly updated to use Terraform Registry (`isThirdPartyProviderExperienceEnabled=true`). See [UpdateStack](#/en/resourcemanager/latest/Stack/UpdateStack). For more information, see [Using Terraform Registry with an Older Stack](/iaas/Content/ResourceManager/Tasks/update-stack-tf-reg.htm). ' properties: bucketName: description: 'The name of the bucket that contains the binary files for the custom Terraform providers. For information about buckets, see [Managing Buckets](/iaas/Content/Object/Tasks/managingbuckets.htm). ' type: string namespace: description: 'The Object Storage namespace that contains the bucket you want. For information about Object Storage namespaces, see [Understanding Object Storage Namespaces](/iaas/Content/Object/Tasks/understandingnamespaces.htm). ' type: string region: description: 'The name of the region that contains the bucket you want. For information about regions, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm). Example: `us-phoenix-1` ' type: string required: - region - namespace - bucketName type: object x-example: "{\n \"region\": \"us-phoenix-1\",\n \"namespace\": \"<bucket_namespace>\",\n \"bucketName\": \"<bucket_name>\"\n}\n" PrivateServerConfigDetails: description: 'Details about a private endpoint associated with the configuration source provider. ' properties: certificateId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a certificate associated with the configuration source provider. ' type: string privateEndpointId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a private endpoint associated with the configuration source provider. ' type: string required: - privateEndpointId type: object x-example: "{\n \"privateEndpointId\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"sslCertificateId\": \"ocid1.certificate.oc1..<unique_ID>\"\n}\n" CreatePrivateEndpointDetails: description: 'Creation details for a private endpoint. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the private endpoint. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver. ' items: type: string maxItems: 5 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isUsedWithConfigurationSourceProvider: description: When `true`, allows the private endpoint to be used with a configuration source provider. type: boolean nsgIdList: description: 'The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) for the private endpoint. Order does not matter. ' items: type: string type: array subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. type: string required: - compartmentId - displayName - vcnId - subnetId type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<compartment_OCID>\",\n \"displayName\": \"My Private Endpoint\",\n \"description\": \"Example Private Endpoint\",\n \"vcnId\": \"ocid1.vcn.oc1.phx.<vcn_OCID>\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.<subnet_OCID>\",\n \"dnsZones\": [\"abc.oraclevcn.com\", \"def.oraclevcn.com\"],\n \"nsgIdList\": [\"ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>\",\"ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>\"],\n \"isUsedWithConfigurationSourceProvider\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n },\n \"securityAttributes\": {\n \"oracle-zpr\": {\n \"MaxEgressCount\": {\n \"mode\": \"enforce\",\n \"value\": \"45\"\n }\n }\n }\n}\n" ConfigurationSourceProviderSummary: description: 'Summary information for a configuration source provider. ' discriminator: propertyName: configSourceProviderType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where the configuration source provider is located. type: string configSourceProviderType: description: 'The type of configuration source provider. The `BITBUCKET_CLOUD_ACCESS_TOKEN` type corresponds to Bitbucket Cloud. The `BITBUCKET_SERVER_ACCESS_TOKEN` type corresponds to Bitbucket Server. The `GITLAB_ACCESS_TOKEN` type corresponds to GitLab. The `GITHUB_ACCESS_TOKEN` type corresponds to GitHub. ' type: string x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/configSourceProviderType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: General description of the configuration source provider. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider. type: string isMigrationRequired: description: 'Indicates whether this configuration source provider uses legacy Bitbucket Cloud username/app-password credentials and must be migrated. ' type: boolean lifecycleState: description: 'Current state of the specified configuration source provider. For more information about configuration source provider lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__CSPStates). ' type: string x-obmcs-enumref: '#/definitions/ConfigurationSourceProvider/lifecycleState' privateServerConfigDetails: $ref: '#/components/schemas/PrivateServerConfigDetails' 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 date and time when the configuration source provider was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string required: - configSourceProviderType x-example: "{\n \"id\": \"ocid1.configSourceProvider.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"My Configuration Source Provider\",\n \"description\": Example Git Source\",\n \"timeCreated\": \"2019-10-02T19:18:44.437Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"configSourceProviderType\": \"GITLAB_ACCESS_TOKEN\",\n \"apiEndpoint\": \"https://gitlab.com\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Project\": \"DC1\"\n }\n }\n}\n" FailureDetails: properties: code: description: Job failure reason. enum: - INTERNAL_SERVICE_ERROR - TERRAFORM_EXECUTION_ERROR - TERRAFORM_CONFIG_UNZIP_FAILED - INVALID_WORKING_DIRECTORY - JOB_TIMEOUT - TERRAFORM_CONFIG_VIRUS_FOUND - TERRAFORM_GIT_CLONE_FAILURE - TERRAFORM_GIT_CHECKOUT_FAILURE - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_EMPTY_BUCKET - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_NO_TF_FILE_PRESENT - TERRAFORM_OBJECT_STORAGE_CONFIG_SOURCE_UNSUPPORTED_OBJECT_SIZE - CUSTOM_TERRAFORM_PROVIDER_BUCKET_NOT_FOUND - CUSTOM_TERRAFORM_PROVIDER_UNSUPPORTED_OBJECT_SIZE type: string message: description: A human-readable error string. type: string required: - code - message CreateJobDetails: description: 'Creation details for a job for running inside the specified stack. ' properties: applyJobPlanResolution: $ref: '#/components/schemas/ApplyJobPlanResolution' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobOperationDetails: $ref: '#/components/schemas/CreateJobOperationDetails' operation: description: Terraform-specific operation to execute. type: string x-obmcs-enumref: '#/definitions/Job/operation' stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the current job. type: string required: - stackId type: object x-example: "{\n \"displayName\": \"Job Display Name\",\n \"stackId\": \"ocid1.ormstack.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"operation\": \"APPLY\",\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" Job: description: 'The properties of a job. A job performs the actions that are defined in your Terraform configuration. For instructions on managing jobs, see [Managing Jobs](/iaas/Content/ResourceManager/Tasks/jobs.htm). For more information about jobs, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__jobdefinition). ' properties: applyJobPlanResolution: $ref: '#/components/schemas/ApplyJobPlanResolution' cancellationDetails: $ref: '#/components/schemas/CancellationDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the job's associated stack resides. type: string configSource: $ref: '#/components/schemas/ConfigSourceRecord' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string failureDetails: $ref: '#/components/schemas/FailureDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job. type: string isProviderUpgradeRequired: default: false description: 'Specifies whether or not to upgrade provider versions. Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. For more information about this option, see [Dependency Lock File (terraform.io)](https://www.terraform.io/language/files/dependency-lock). ' type: boolean isThirdPartyProviderExperienceEnabled: description: 'When `true`, the stack sources third-party Terraform providers from [Terraform Registry](https://registry.terraform.io/browse/providers) and allows [custom providers](#/en/resourcemanager/latest/datatypes/CustomTerraformProvider). For more information about stack sourcing of third-party Terraform providers, see [Third-party Provider Configuration](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#third-party-providers). ' type: boolean jobOperationDetails: $ref: '#/components/schemas/JobOperationDetails' lifecycleState: description: 'Current state of the specified job. For more information about job lifecycle states in Resource Manager, see [Key Concepts](/iaas/Content/ResourceManager/Concepts/resourcemanager.htm#concepts__JobStates). ' enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string operation: description: The type of job executing. enum: - PLAN - APPLY - DESTROY - IMPORT_TF_STATE - PLAN_ROLLBACK - APPLY_ROLLBACK type: string resolvedPlanJobId: description: 'Deprecated. Use the property `executionPlanJobId` in `jobOperationDetails` instead. The plan job [OCID](/iaas/Content/General/Concepts/identifiers.htm) that was used (if this was an apply job and was not auto-approved). ' type: string stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stack that is associated with the job. 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 date and time when the job was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The date and time when the job stopped running, irrespective of whether the job ran successfully. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string variables: additionalProperties: type: string description: 'Terraform variables associated with this resource. Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: `{"CompartmentId": "compartment-id-value"}` ' maxProperties: 250 type: object workingDirectory: description: 'File path to the directory to use for running Terraform. If not specified, the root directory is used. Required when using a zip Terraform configuration (`configSourceType` value of `ZIP_UPLOAD`) that contains folders. Ignored for the `configSourceType` value of `COMPARTMENT_CONFIG_SOURCE`. For more information about required and recommended file structure, see [File Structure (Terraform Configurations for Resource Manager)](/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager.htm#filestructure). ' type: string type: object x-example: "{\n \"id\": \"ocid1.ormjob.oc1..<unique_ID>\",\n \"stackId\": \"ocid1.ormstackoc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Job Display Name\",\n \"operation\": \"Apply\",\n \"jobOperationDetails\": {\n \"operation\": \"APPLY\",\n \"executionPlanStrategy\": \"FROM_PLAN_JOB_ID\",\n \"executionPlanJobId\": \"ocid1.ormjob.oc1..<unique_ID>\"\n },\n \"applyJobPlanResolution\": {\n \"planJobId\": \"ocid1.ormjob.oc1..<unique_ID>\"\n },\n \"resolvedPlanJobId\": \"ocid1.ormjob.oc1..<unique_ID>\",\n \"timeCreated\": \"2018-10-02T19:18:44.437Z\",\n \"timeFinished\": \"2018-10-02T19:18:44.439Z\",\n \"lifecycleState\": \"IN_PROGRESS\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n \"variables\": {\n \"additionalProp1\": \"myVariable01\",\n \"additionalProp2\": \"myVariable02\"\n },\n \"configSource\": {\n \"configSourceType\": \"GIT_CONFIG_SOURCE\",\n \"workingDirectory\": \"<file_path_to_directory>\",\n \"configurationSourceProviderId\": \"ocid1.ormconfigsourceprovider.oc1..<unique_ID>\",\n \"branchName\": \"MyBranch\",\n \"repositoryUrl\":\"https://github.com/user/repo.git\",\n \"commitId\": \"2dc979a95e86abb211eda8515e1655dfa4275a00\"\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" ConfigurationSourceProviderCollection: description: 'Collection of configuration source providers. ' properties: items: description: Collection of configuration source providers. items: $ref: '#/components/schemas/ConfigurationSourceProviderSummary' type: array type: object AssociatedResourceSummary: description: 'Summary information for a resource associated with a stack or job. ' properties: attributes: additionalProperties: type: string description: 'Resource attribute values. Each value is represented as a key-value pair. Example: `{"state": "AVAILABLE"}` ' type: object region: description: "Resource region. \nFor information about regions, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nExample: `us-phoenix-1`\n" type: string resourceAddress: description: Terraform resource address. type: string resourceId: description: Unique identifier for the resource. type: string resourceName: description: Name of the resource. type: string resourceType: description: Resource type. For more information about resource types supported for the Oracle Cloud Infrastructure (OCI) provider, see [Oracle Cloud Infrastructure Provider](https://registry.terraform.io/providers/oracle/oci/latest/docs). type: string timeCreated: description: 'The date and time when the stack was created. Format is defined by RFC3339. Example: `2022-07-25T21:10:29.600Z` ' format: date-time type: string x-example: "{\n id: \"ocid1.instance.oc1.phx.anyhqljrfvoefqyc5pous5opmo57ql2gudgg5goqvzhmebs6ul6pthzdesyq\",\n name: \"TFInstance0\",\n type: \"oci_core_instance\",\n timeCreated: 2020-05-13T21:57:07.363\"\n region: \"us-phoenix-1\"\n attributes: {\n \"id\": \"ocid1.instance.oc1.phx.anyhqljrfvoefqyc5pous5opmo57ql2gudgg5goqvzhmebs6ul6pthzdesyq\",\n \"image\": \"ocid1.image.oc1.phx.aaaaaaaaupbfz5f5hdvejulmalhyb6goieolullgkpumorbvxlwkaowglslq\",\n }\n}\n" TemplateSummary: description: 'Summary information for a template. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Brief description of the template. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier of the specified template. type: string isFreeTier: description: whether the template will work for free tier tenancy. type: boolean lifecycleState: description: 'The current lifecycle state of the template. ' type: string x-obmcs-enumref: '#/definitions/Template/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 date and time at which the template was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z` ' format: date-time type: string x-example: "{\n \"id\": \"ocid1.template.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Template Display Name\",\n \"description\": \"Brief description of the template\",\n \"timeCreated\": \"2020-10-02T19:18:44.437Z\"\n}\n" TemplateCategorySummaryCollection: description: 'Results of a `ListTemplateCategories` operation. ' properties: items: description: A list of template categories. items: $ref: '#/components/schemas/TemplateCategorySummary' type: array required: - items type: object ChangeStackCompartmentDetails: description: Compartment details for moving a stack. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the Stack should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" PrivateEndpoint: description: 'A private endpoint allowing Resource Manager to access nonpublic cloud resources. For more information about private endpoints, see [Managing Private Endpoints](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the private endpoint. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'DNS zones to use for accessing private Git servers. For private Git server instructions, see [Private Git Server](/iaas/Content/ResourceManager/Tasks/private-endpoints.htm#private-git). Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: `abc.oraclevcn.com` ' items: type: string maxItems: 5 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. type: string isUsedWithConfigurationSourceProvider: description: When `true`, allows the private endpoint to be used with a configuration source provider. type: boolean lifecycleState: description: 'The current lifecycle state of the private endpoint. ' enum: - ACTIVE - CREATING - DELETING - DELETED - FAILED type: string nsgIdList: description: 'The [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of [network security groups (NSGs)](/iaas/Content/Network/Concepts/networksecuritygroups.htm) for the private endpoint. Order does not matter. ' items: type: string type: array sourceIps: description: The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager. items: type: string type: array subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint. 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 date and time at which the private endpoint was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint. type: string required: - id - compartmentId - vcnId - subnetId type: object x-example: "{\n \"id\": \"ocid1.ormprivateendpoint.oc1..<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<compartment_OCID>\",\n \"displayName\": \"My Private Endpoint\",\n \"description\": \"Example Private Endpoint\",\n \"vcnId\": \"ocid1.vcn.oc1.phx.<vcn_OCID>\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.<subnet_OCID>\",\n \"sourceIps\": [\"10.0.0.0\", \"10.0.0.1\"],\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2020-10-02T19:18:44.437Z\",\n \"nsgIdList\": [\"ocid1.networksecuritygroup.oc1.phx.<nsg1_OCID>\",\"ocid1.networksecuritygroup.oc1.phx.<nsg2_OCID>\"],\n \"isUsedWithConfigurationSourceProvider\": true,\n \"freeformTags\": {\n \"additionalProp1\": \"{\"Department\": \"Finance\"}\",\n },\n \"dnsZones\": [\"abc.oraclevcn.com\", \"def.oraclevcn.com\"]\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n },\n \"securityAttributes\": {\n \"oracle-zpr\": {\n \"MaxEgressCount\": {\n \"mode\": \"enforce\",\n \"value\": \"45\"\n }\n }\n }\n}\n" UpdateTemplateDetails: description: 'Update details for a template. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the template. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logoFileBase64Encoded: description: Base64-encoded logo for the template. type: string longDescription: description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. maxLength: 5000 type: string templateConfigSource: $ref: '#/components/schemas/UpdateTemplateConfigSourceDetails' type: object x-example: "{\n \"displayName\": \"Template Display Name\",\n \"description\": \"Brief description of the template\",\n \"longDescription\": \"Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.\",\n \"logoFileBase64Encoded\": \"binary string\",\n \"templateConfigSource\": {\n \"templateConfigSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"DC1\"\n }\n }\n}\n" CreateTemplateConfigSourceDetails: description: 'Creation details for a configuration source used for a template. ' discriminator: propertyName: templateConfigSourceType properties: templateConfigSourceType: description: 'Specifies the `configSourceType` for uploading the Terraform configuration. ' type: string x-obmcs-enumref: '#/definitions/TemplateConfigSource/templateConfigSourceType' required: - templateConfigSourceType CreateTemplateDetails: description: 'Creation details for a template. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this template. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Description of the template. Avoid entering confidential information. maxLength: 500 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object logoFileBase64Encoded: description: 'Base64-encoded logo to use as the template icon. Template icon file requirements: PNG format, 50 KB maximum, 110 x 110 pixels. ' type: string longDescription: description: Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded. Avoid entering confidential information. maxLength: 5000 type: string templateConfigSource: $ref: '#/components/schemas/CreateTemplateConfigSourceDetails' required: - compartmentId - displayName - description - templateConfigSource type: object x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"Template Display Name\",\n \"description\": \"Brief description of the template\",\n \"longDescription\": \"Detailed description of the template. This description is displayed in the Console page listing templates when the template is expanded.\",\n \"logoFileBase64Encoded\": \"binary string\",\n \"templateConfigSource\": {\n \"templateConfigSourceType\": \"ZIP_UPLOAD\",\n \"zipFileBase64Encoded\": \"<zip_file_content_encoded_in_base64_format>\",\n },\n \"freeformTags\": {\n \"Department\": \"Finance\",\n \"Group\": \"D\"\n },\n \"definedTags\": {\n \"ProjectTags\": {\n \"Owner\": \"Operations\"\n }\n }\n}\n" LogEntry: description: Log entry for an operation resulting from a job's execution. properties: level: description: Specifies the severity level of the log entry. enum: - TRACE - DEBUG - INFO - WARN - ERROR - FATAL type: string message: description: The log entry value. type: string timestamp: description: 'The date and time of the log entry. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z` ' format: date-time type: string type: description: Specifies the log type for the log entry. enum: - TERRAFORM_CONSOLE type: string type: object x-example: "{\n \"type\": \"TERRAFORM_CONSOLE\",\n \"level\": \"TRACE\",\n \"timestamp\": \"2018-10-09T19:54:55.857Z\",\n \"message\": \"<log_entry>\"\n}\n" ChangeConfigurationSourceProviderCompartmentDetails: description: 'Compartment details for moving a configuration source provider. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the configuration source provider to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"<compartment_OCID>\"\n}\n" 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 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: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the string data type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/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.orchestration.orm