openapi: 3.2.0 info: description: 'Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise. ' title: Fleet Application Management Service Fleet Apps Management Admin API version: '20250228' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Fleet Application Management Service 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/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml what: the harvested document for Fleet Application Management Service API servers: - url: http://127.0.0.1/20250228 - url: https://127.0.0.1/20250228 tags: - name: fleetAppsManagementAdmin paths: /compliancePolicies: get: description: 'Returns a list of all the Compliance Policies in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListCompliancePolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompliancePolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompliancePolicyTypeQueryParam' - $ref: '#/components/parameters/CompliancePolicyIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CompliancePolicySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CompliancePolicySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompliancePolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of compliancePolicies. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/CompliancePolicyCollection' /compliancePolicies/{compliancePolicyId}: get: description: Gets information about a compliance policy. operationId: GetCompliancePolicy parameters: - $ref: '#/components/parameters/CompliancePolicyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The CompliancePolicy was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompliancePolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get CompliancePolicy tags: - fleetAppsManagementAdmin /compliancePolicyRules: get: description: 'Gets a list of Compliance policy rules in a compartment. ' operationId: ListCompliancePolicyRules parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/CompliancePolicyRuleLifecycleStateQueryParam' - $ref: '#/components/parameters/CompliancePolicyRulePatchNameQueryParam' - $ref: '#/components/parameters/AssociatedCompliancePolicyIdentifierQueryParam' - $ref: '#/components/parameters/CompliancePolicyRuleIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CompliancePolicyRuleSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CompliancePolicyRuleSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompliancePolicyRuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of compliancePolicyRules. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/CompliancePolicyRuleCollection' post: description: 'Creates a compliance policy rule. ' operationId: CreateCompliancePolicyRule parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The CompliancePolicyRule will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created CompliancePolicyRule. The CompliancePolicyRule OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompliancePolicyRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a CompliancePolicyRule. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/CompliancePolicyRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCompliancePolicyRuleDetails' description: Details for the new CompliancePolicyRule. required: true /compliancePolicyRules/{compliancePolicyRuleId}: delete: description: Deletes a compliance policy rule specified by an identifier. operationId: DeleteCompliancePolicyRule parameters: - $ref: '#/components/parameters/CompliancePolicyRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The CompliancePolicyRule will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a CompliancePolicyRule. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/CompliancePolicyRule' get: description: Gets information about a compliance policy rule. operationId: GetCompliancePolicyRule parameters: - $ref: '#/components/parameters/CompliancePolicyRuleIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The CompliancePolicyRule was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompliancePolicyRule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get CompliancePolicyRule tags: - fleetAppsManagementAdmin put: description: Updates a compliance policy rule specified by an identifier. operationId: UpdateCompliancePolicyRule parameters: - $ref: '#/components/parameters/CompliancePolicyRuleIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The CompliancePolicyRule will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a CompliancePolicy. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/CompliancePolicyRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCompliancePolicyRuleDetails' description: The information to be updated. required: true /onboardingPolicies: get: description: 'Returns a list of onboarding policy information for Fleet Application Management. ' operationId: ListOnboardingPolicies parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FamsOnboardingPoliciesSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Fleet Application Management onboard policy information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnboardingPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of onboarding policy information for Fleet Application Management tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/OnboardingPolicyCollection' /onboardings: get: description: 'Returns a list of all the onboardings in the specified root compartment (tenancy). The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListOnboardings parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FamsOnboardingLifecycleStateQueryParam' - $ref: '#/components/parameters/FamsOnboardingIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Fleet Application Management onboarding information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnboardingCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of onboarding information for the Tenancy tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/OnboardingCollection' post: description: 'Onboard a tenant to Fleet Application Management. The onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features. ' operationId: CreateOnboarding parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Onboarding will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created Onboarding, the Onboarding id will be generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Onboarding' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Onboard a tenant to Fleet Application Management. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Onboarding' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOnboardingDetails' description: Details for onboarding Fleet Application Management. required: true /onboardings/{onboardingId}: delete: description: Deletes Fleet Application Management onboarding resource by identifier operationId: DeleteOnboarding parameters: - $ref: '#/components/parameters/FamsOnboardingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Fleet Application Management Onboarding will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete Fleet Application Management onboarding for a Tenant tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Onboarding' get: description: Gets a Fleet Application Management Onboarding by identifier. operationId: GetOnboarding parameters: - $ref: '#/components/parameters/FamsOnboardingIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Fleet Application Management Onboarding with the given id. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Onboarding' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Fleet Application Management OnboardingDetails tags: - fleetAppsManagementAdmin put: description: Updates the Onboarding operationId: UpdateOnboarding parameters: - $ref: '#/components/parameters/FamsOnboardingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Onboarding will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Onboarding identified by the id tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Onboarding' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOnboardingDetails' description: The information to be updated. required: true /onboardings/{onboardingId}/actions/enableLatestPolicy: post: description: Enable Policies for a newer version of Fleet Application Management operationId: EnableLatestPolicy parameters: - $ref: '#/components/parameters/FamsOnboardingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Enable Policies for a newer version of Fleet Application Management tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Onboarding' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableLatestPolicyDetails' description: The information to be updated. required: true /onboardings/{onboardingId}/actions/manageSettings: post: description: Updates the Onboarding setting operationId: ManageSettings parameters: - $ref: '#/components/parameters/FamsOnboardingIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The operation is completed successfully headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Manage the onboarding settings identified by the id tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Onboarding' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManageSettingsDetails' description: The information to be updated. required: true /platformConfigurations: get: description: 'Returns a list of all the Platform Configurations in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListPlatformConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PlatformConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PlatformConfigurationIdentifierQueryParam' - $ref: '#/components/parameters/PlatformConfigurationCategoryQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PlatformConfigurationTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PlatformConfigurationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PlatformConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PlatformConfigurationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Platform Configurations in a compartment tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PlatformConfigurationCollection' post: description: 'Creates a new PlatformConfiguration. ' operationId: CreatePlatformConfiguration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The PlatformConfiguration will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created PlatformConfiguration, the PlatformConfiguration id will be generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PlatformConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new PlatformConfiguration tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PlatformConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlatformConfigurationDetails' description: Details for the new PlatformConfiguration. required: true /platformConfigurations/{platformConfigurationId}: delete: description: Deletes a PlatformConfiguration resource by identifier operationId: DeletePlatformConfiguration parameters: - $ref: '#/components/parameters/PlatformConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The PlatformConfiguration Window will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned PlatformConfiguration tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PlatformConfiguration' get: description: Gets a PlatformConfiguration by identifier operationId: GetPlatformConfiguration parameters: - $ref: '#/components/parameters/PlatformConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the PlatformConfiguration with the given identifier. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PlatformConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get PlatformConfiguration tags: - fleetAppsManagementAdmin put: description: Updates the PlatformConfiguration operationId: UpdatePlatformConfiguration parameters: - $ref: '#/components/parameters/PlatformConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The PlatformConfiguration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the PlatformConfiguration identified by the id tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PlatformConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePlatformConfigurationDetails' description: The information to be updated. required: true /platformConfigurations/{platformConfigurationId}/actions/changeCompartment: post: description: 'Moves a PlatformConfiguration into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangePlatformConfigurationCompartment parameters: - $ref: '#/components/parameters/PlatformConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The PlatformConfiguration will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a PlatformConfiguration into a different compartment. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PlatformConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePlatformConfigurationCompartmentDetails' description: Details of the target compartment. required: true /properties: get: description: 'Returns a list of all the Properties in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListProperties parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PropertyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PropertyIdentifierQueryParam' - $ref: '#/components/parameters/PropertyTypeQueryParam' - $ref: '#/components/parameters/ScopeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PropertySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of PropertySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PropertyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Properties in a Tenancy tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/PropertyCollection' post: description: 'Create a business-specific metadata property in Fleet Application Management. ' operationId: CreateProperty parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Property created successfully. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Property' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Property tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Property' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePropertyDetails' description: Details for the new Property. required: true /properties/{propertyId}: delete: description: Delete a property in Fleet Application Management. operationId: DeleteProperty parameters: - $ref: '#/components/parameters/PropertyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Property is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Property tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Property' get: description: Gets a Property by identifier operationId: GetProperty parameters: - $ref: '#/components/parameters/PropertyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Property with the given id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Property' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Property tags: - fleetAppsManagementAdmin put: description: Update a property in Fleet Application Management. operationId: UpdateProperty parameters: - $ref: '#/components/parameters/PropertyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Property updated successfully. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Property' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Property identified by the id tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Property' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePropertyDetails' description: The information to be updated. required: true /properties/{propertyId}/actions/changeCompartment: post: description: 'Moves a Property into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangePropertyCompartment parameters: - $ref: '#/components/parameters/PropertyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Property will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a Property into a different compartment. tags: - fleetAppsManagementAdmin x-related-resource: '#/definitions/Property' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePropertyCompartmentDetails' description: Details of the target compartment. required: true components: schemas: ChangePropertyCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Property to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Property: description: Global metadata element details. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Property. enum: - ACTIVE - DELETED - FAILED - UPDATING type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' scope: description: The scope of the property. enum: - TAXONOMY - PLATFORM_CONFIG type: string x-obmcs-top-level-enum: '#/definitions/Scope' selection: description: Text selection of the property. enum: - SINGLE_CHOICE - MULTI_CHOICE - DEFAULT_TEXT type: string x-obmcs-top-level-enum: '#/definitions/Selection' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the property. enum: - USER_DEFINED - ORACLE_DEFINED - SYSTEM_DEFINED type: string valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' values: description: Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array required: - id - compartmentId - lifecycleState - timeCreated - displayName - resourceRegion type: object UpdatePropertyDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object selection: description: Text selection of the property. enum: - SINGLE_CHOICE - MULTI_CHOICE - DEFAULT_TEXT type: string x-obmcs-top-level-enum: '#/definitions/Selection' valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' values: description: Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array type: object ChangePlatformConfigurationCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Platform Configuration to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PropertyCollection: description: Results of a property search. Contains both PropertySummary items and other information, such as metadata. properties: items: description: List of properties. items: $ref: '#/components/schemas/PropertySummary' type: array required: - items type: object OnboardingCollection: description: List of Fleet Application Management Onboardings. properties: items: description: List of Fleet Application Management Onboardings. items: $ref: '#/components/schemas/OnboardingSummary' type: array required: - items type: object CompliancePolicyRuleCollection: description: Results of a compliancePolicyRule search. Contains both CompliancePolicyRuleSummary items and other information, such as metadata. properties: items: description: List of complianePolicyRules. items: $ref: '#/components/schemas/CompliancePolicyRuleSummary' type: array required: - items type: object CompliancePolicyRuleSummary: description: Summary information about a CompliancePolicyRule. properties: compartmentId: description: The OCID of the compartment the CompliancePolicyRule belongs to. type: string compliancePolicyId: description: Unique OCID of the CompliancePolicy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracePeriod: description: 'Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn''t report the product as noncompliant when patch is not applied. ' format: x-obmcs-duration type: string id: description: Unique OCID of the CompliancePolicyRule. type: string lifecycleDetails: description: 'A message that describes the current state of the CompliancePolicyRule in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the CompliancePolicyRule. type: string x-obmcs-enumref: '#/definitions/CompliancePolicyRule/lifecycleState' patchSelection: $ref: '#/components/schemas/PatchSelectionDetails' patchTypeId: description: PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. items: type: string maxItems: 20 type: array productVersion: $ref: '#/components/schemas/ProductVersionDetails' severity: description: Severity to which this CompliancePolicyRule applies. items: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/ComplianceRuleSeverity' maxItems: 20 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the CompliancePolicyRule was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the CompliancePolicyRule was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - displayName - compartmentId - compliancePolicyId - lifecycleState - timeCreated - productVersion - patchTypeId - patchSelection type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message CreateCompliancePolicyRuleDetails: description: The data to create a CompliancePolicyRule. properties: compliancePolicyId: description: Unique OCID of the CompliancePolicy this CompliancePolicyRule belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracePeriod: description: 'Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn''t report the product as noncompliant when patch is not applied. ' format: x-obmcs-duration type: string patchSelection: $ref: '#/components/schemas/PatchSelectionDetails' patchTypeId: description: PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. items: maxLength: 255 minLength: 1 type: string maxItems: 20 minItems: 1 type: array productVersion: $ref: '#/components/schemas/ProductVersionDetails' severity: description: Severity to which this CompliancePolicyRule applies. items: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/ComplianceRuleSeverity' maxItems: 20 type: array required: - productVersion - patchTypeId - patchSelection - displayName - compliancePolicyId type: object Onboarding: description: 'Fleet Application Management onboarding resource. The onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features. ' properties: appliedPolicies: $ref: '#/components/schemas/OnboardingPolicySummary' compartmentId: description: Tenancy OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object discoveryFrequency: description: Provide discovery frequency. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string isCostTrackingTagEnabled: default: false description: 'A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. ' type: boolean isFamsTagEnabled: default: false description: 'A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. ' type: boolean lifecycleState: description: The current state of the Onboarding. enum: - ACTIVE - INACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING - NEEDS_ATTENTION type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: The version of Fleet Application Management that the tenant is onboarded to. type: string required: - id - compartmentId - lifecycleState type: object OnboardingPolicySummary: description: Summary of the Fleet Application Management Onboard Policy. properties: id: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string statements: description: Policy statements. items: maxLength: 1024 type: string maxItems: 100 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id type: object CreatePropertyDetails: description: The information about new Property. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object selection: description: Text selection of the property. enum: - SINGLE_CHOICE - MULTI_CHOICE - DEFAULT_TEXT type: string x-obmcs-top-level-enum: '#/definitions/Selection' valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' values: description: Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array required: - compartmentId - selection - valueType - displayName type: object CompliancePolicyRule: description: "Set of rules that are used to calculate the compliance status of the product. \nSpecific rules will take precedence over broader rules.\n" properties: compartmentId: description: The OCID of the compartment the CompliancePolicyRule belongs to. type: string compliancePolicyId: description: Unique OCID of the CompliancePolicy. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracePeriod: description: 'Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn''t report the product as noncompliant when patch is not applied. ' format: x-obmcs-duration type: string id: description: Unique OCID of the CompliancePolicyRule. type: string lifecycleDetails: description: 'A message that describes the current state of the CompliancePolicyRule in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the CompliancePolicyRule. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string patchSelection: $ref: '#/components/schemas/PatchSelectionDetails' patchTypeId: description: PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. items: type: string maxItems: 20 type: array productVersion: $ref: '#/components/schemas/ProductVersionDetails' severity: description: Severity to which this CompliancePolicyRule applies. items: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/ComplianceRuleSeverity' maxItems: 20 type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the CompliancePolicyRule was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the CompliancePolicyRule was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - displayName - compartmentId - compliancePolicyId - lifecycleState - timeCreated - productVersion - patchTypeId - patchSelection - freeformTags - definedTags type: object OnboardingSummary: description: Summary of the Fleet Application Management Onboarding. properties: appliedPolicies: $ref: '#/components/schemas/OnboardingPolicySummary' compartmentId: description: Tenancy OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object discoveryFrequency: description: Provide discovery frequency. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string isCostTrackingTagEnabled: default: false description: 'A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. ' type: boolean isFamsTagEnabled: default: false description: 'A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. ' type: boolean lifecycleState: description: The current state of the Onboarding. type: string x-obmcs-enumref: '#/definitions/Onboarding/lifecycleState' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: The version of Fleet Application Management that the tenant is onboarded to. type: string required: - id - compartmentId - lifecycleState type: object CreatePlatformConfigurationDetails: description: The information about new PlatformConfiguration. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string configCategoryDetails: $ref: '#/components/schemas/ConfigCategoryDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - compartmentId - configCategoryDetails - displayName type: object CreateOnboardingDetails: description: The information about enabling onboarding. properties: compartmentId: description: Tenancy OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isCostTrackingTagEnabled: default: false description: 'A value determining if the cost tracking tag is enabled or not. Allow Fleet Application Management to tag resources with cost tracking tag using "Oracle$FAMS-Tags.FAMSManaged" tag. ' type: boolean isFamsTagEnabled: default: false description: 'A value determining if the Fleet Application Management tagging is enabled or not. Allow Fleet Application Management to tag resources with fleet name using "Oracle$FAMS-Tags.FleetName" tag. ' type: boolean required: - compartmentId type: object EnableLatestPolicyDetails: description: The information to be updated. properties: canLatestFamsPoliciesBeEnabled: default: true description: A value determining if latest Fleet Application Management policies should be enabled type: boolean type: object ProductVersionDetails: description: 'A specific product version or a specific version and succeeding. Example: 12.1 or 12.1 and above for Oracle WebLogic Application server. The policy applies to the next version only, and not to other versions such as, 12.1.x. ' properties: isApplicableForAllHigherVersions: default: false description: Is rule applicable to all higher versions also type: boolean version: description: Product version the rule is applicable. maxLength: 20 minLength: 1 type: string required: - version PlatformConfiguration: description: Fleet Application Management Platform Configuration . properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string configCategoryDetails: $ref: '#/components/schemas/ConfigCategoryDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the PlatformConfiguration. enum: - ACTIVE - DELETED - FAILED - DELETING - UPDATING - CREATING - INACTIVE type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the configuration. enum: - USER_DEFINED - ORACLE_DEFINED type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - resourceRegion type: object PatchSelectionDetails: description: Patch Selection Details discriminator: propertyName: selectionType properties: selectionType: description: 'Selection type for the Patch. ' enum: - PATCH_LEVEL - PATCH_NAME - PATCH_RELEASE_DATE type: string required: - selectionType PlatformConfigurationSummary: description: Summary of the PlatformConfiguration. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string configCategoryDetails: $ref: '#/components/schemas/ConfigCategoryDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the PlatformConfiguration. type: string x-obmcs-enumref: '#/definitions/PlatformConfiguration/lifecycleState' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the configuration. type: string x-obmcs-enumref: '#/definitions/PlatformConfiguration/type' required: - id - compartmentId - lifecycleState - timeCreated - displayName - resourceRegion type: object PropertySummary: description: Summary of the Property. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Property. type: string x-obmcs-enumref: '#/definitions/Property/lifecycleState' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' scope: description: The scope of the property. enum: - TAXONOMY - PLATFORM_CONFIG type: string x-obmcs-top-level-enum: '#/definitions/Scope' selection: description: Text selection of the property. enum: - SINGLE_CHOICE - MULTI_CHOICE - DEFAULT_TEXT type: string x-obmcs-top-level-enum: '#/definitions/Selection' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the property. type: string x-obmcs-enumref: '#/definitions/Property/type' valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' values: description: Values of the property (must be a single value if selection = 'SINGLE_CHOICE'). items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array required: - id - compartmentId - lifecycleState - timeCreated - displayName - resourceRegion type: object CompliancePolicySummary: description: Summary information about a CompliancePolicy. properties: compartmentId: description: The OCID of the compartment the CompliancePolicy belongs to. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Display name for the CompliancePolicy. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the CompliancePolicy. type: string lifecycleDetails: description: 'A message that describes the current state of the CompliancePolicy in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the CompliancePolicy. type: string x-obmcs-enumref: '#/definitions/CompliancePolicy/lifecycleState' productId: description: platformConfiguration OCID corresponding to the Product. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the CompliancePolicy was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the CompliancePolicy was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: The type of the Compliance Policy. type: string x-obmcs-enumref: '#/definitions/CompliancePolicy/type' required: - id - compartmentId - lifecycleState - timeCreated - displayName - productId - freeformTags - definedTags type: object ConfigCategoryDetails: description: Config Category Details. discriminator: propertyName: configCategory properties: configCategory: description: Category of configuration enum: - PRODUCT - PRODUCT_STACK - ENVIRONMENT - PATCH_TYPE - CREDENTIAL - SELF_HOSTED_INSTANCE - LIFECYCLE_OPERATION type: string required: - configCategory type: object OnboardingPolicyCollection: description: List of Fleet Application Management Onboard policies. properties: items: description: List of Fleet Application Management Onboard policies. items: $ref: '#/components/schemas/OnboardingPolicySummary' type: array required: - items type: object UpdatePlatformConfigurationDetails: description: The information to be updated. properties: configCategoryDetails: $ref: '#/components/schemas/ConfigCategoryDetails' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object ManageSettingsDetails: description: The information to be updated. properties: discoveryFrequency: description: Provide discovery frequency. format: x-obmcs-duration type: string type: object UpdateOnboardingDetails: description: The information about updating onboarding. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isCostTrackingTagEnabled: default: false description: A value determining if cost tracking tag is enabled or not type: boolean isFamsTagEnabled: default: false description: A value determining Fleet Application Management tag is enabled or not type: boolean type: object CompliancePolicy: description: 'Define software patch compliance policies for various products running in OCI resources. A compliance policy is a configuration you set up for various products to report compliance by defining the schedule and patch baseline. ' properties: compartmentId: description: The OCID of the compartment the CompliancePolicy belongs to. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Display name for the CompliancePolicy. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the CompliancePolicy. type: string lifecycleDetails: description: 'A message that describes the current state of the CompliancePolicy in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the CompliancePolicy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string productId: description: platformConfiguration OCID corresponding to the Product. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the CompliancePolicy was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the CompliancePolicy was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: The type of the Compliance Policy. enum: - USER_DEFINED - ORACLE_DEFINED type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - productId - freeformTags - definedTags type: object CompliancePolicyCollection: description: Results of a compliancePolicy search. Contains both CompliancePolicySummary items and other information, such as metadata. properties: items: description: List of compliance policies. items: $ref: '#/components/schemas/CompliancePolicySummary' type: array required: - items type: object UpdateCompliancePolicyRuleDetails: description: The data to update a CompliancePolicyRule. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracePeriod: description: 'Grace period in days,weeks,months or years the exemption is applicable for the rule. This enables a grace period when Fleet Application Management doesn''t report the product as noncompliant when patch is not applied. ' format: x-obmcs-duration type: string patchSelection: $ref: '#/components/schemas/PatchSelectionDetails' patchTypeId: description: PlatformConfiguration OCID for the patch type to which this CompliancePolicyRule applies. items: maxLength: 255 minLength: 1 type: string maxItems: 20 type: array productVersion: $ref: '#/components/schemas/ProductVersionDetails' severity: description: Severity to which this CompliancePolicyRule applies. items: enum: - CRITICAL - HIGH - MEDIUM - LOW type: string x-obmcs-top-level-enum: '#/definitions/ComplianceRuleSeverity' maxItems: 20 type: array type: object PlatformConfigurationCollection: description: Results of a platform configuration search. properties: items: description: List of configurations items: $ref: '#/components/schemas/PlatformConfigurationSummary' type: array required: - items type: object parameters: FamsOnboardingPoliciesSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. ' in: query name: sortBy schema: type: string enum: - timeCreated default: timeCreated FamsOnboardingLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Onboarding/lifecycleState' schema: type: string PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName PlatformConfigurationLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/PlatformConfiguration/lifecycleState' schema: type: string PropertySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/PropertySortBy' schema: type: string enum: - timeCreated - displayName AssociatedCompliancePolicyIdentifierQueryParam: description: unique CompliancePolicy identifier. in: query name: compliancePolicyId x-default-description: 'null' schema: type: string PropertyTypeQueryParam: description: A filter to return properties whose type matches the given type. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/Property/type' schema: type: string CompliancePolicyLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/CompliancePolicy/lifecycleState' schema: type: string PropertyIdentifierQueryParam: description: "Unique identifier or OCID for listing a single Property by id.\nEither compartmentId or id must be provided.\n \n" in: query name: id x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string CompliancePolicyRuleLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/CompliancePolicyRule/lifecycleState' schema: type: string CompliancePolicyIdentifierPathParam: description: unique CompliancePolicy identifier. in: path name: compliancePolicyId required: true schema: type: string PlatformConfigurationIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: 'The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. ' in: query name: compartmentId x-default-description: 'null' schema: type: string PlatformConfigurationSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/PlatformConfigurationSortBy' schema: type: string enum: - timeCreated - displayName PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 MandatoryCompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string ScopeQueryParam: description: A filter to return only resources their scope matches the given scope. in: query name: scope x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/Scope' schema: type: string enum: - TAXONOMY - PLATFORM_CONFIG CompliancePolicyRuleIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Compliance Policy Rule by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string PropertyLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Property/lifecycleState' schema: type: string FamsOnboardingIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string PlatformConfigurationTypeQueryParam: description: A filter to return Platform Configurations whose type matches the given type. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/PlatformConfiguration/type' schema: type: string CompliancePolicyTypeQueryParam: description: A filter to return Platform Configurations whose type matches the given type. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/CompliancePolicy/type' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC CompliancePolicyRuleSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/CompliancePolicyRuleSortBy' schema: type: string enum: - timeCreated - displayName RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 CompliancePolicySortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/CompliancePolicySortBy' schema: type: string enum: - timeCreated - displayName CompliancePolicyRulePatchNameQueryParam: description: A filter to return only resources that match the patch selection against the given patch name. in: query name: patchName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PlatformConfigurationIdentifierPathParam: description: unique PlatformConfiguration identifier in: path name: platformConfigurationId required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string CompliancePolicyIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Compliance Policy by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string PlatformConfigurationCategoryQueryParam: description: Config Category in: query name: configCategory x-default-description: 'null' x-obmcs-enumref: '#/definitions/ConfigCategoryDetails/configCategory' schema: type: string PropertyIdentifierPathParam: description: unique Property identifier in: path name: propertyId required: true schema: type: string CompartmentIdInSubtreeQueryParam: description: 'If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. ' in: query name: compartmentIdInSubtree required: false schema: type: boolean default: false CompliancePolicyRuleIdentifierPathParam: description: unique CompliancePolicyRule identifier. in: path name: compliancePolicyRuleId required: true schema: type: string FamsOnboardingIdentifierPathParam: description: A filter to return resources whose Onboarding identifier matches the given identifier. in: path name: onboardingId required: true schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-length: description: The content size of the body in bytes. format: int64 type: integer content-type: description: The content type of the body. type: string 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-total-items: description: A number representing the the total number of results available. type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string ocid: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string region: description: Associated region maxLength: 255 type: string x-default-description: 'null' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string uniqueId: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string x-tag-groups: adminWorkRequest: - fleetAppsManagementAdmin announcement: - fleetAppsManagement catalogItem: - fleetAppsManagementCatalog category: - fleetAppsManagementAdmin compliance: - fleetAppsManagementOperations compliancePolicy: - fleetAppsManagementAdmin compliancePolicyRule: - fleetAppsManagementAdmin famProvision: - fleetAppsManagementProvision famReport: - fleetAppsManagementOperations fleet: - fleetAppsManagement fleetCredential: - fleetAppsManagement fleetProperty: - fleetAppsManagement fleetResource: - fleetAppsManagement fleetWorkRequest: - fleetAppsManagementWorkRequest inventory: - fleetAppsManagementOperations inventoryResource: - fleetAppsManagement maintenanceWindow: - fleetAppsManagementMaintenanceWindow onboard: - fleetAppsManagementAdmin patch: - fleetAppsManagementOperations platformConfiguration: - fleetAppsManagementAdmin property: - fleetAppsManagementAdmin runbook: - fleetAppsManagementRunbooks schedulerDefinition: - fleetAppsManagementOperations schedulerJob: - fleetAppsManagementOperations taskRecord: - fleetAppsManagementRunbooks x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.fams