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 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: fleetAppsManagement paths: /announcements: get: description: Return a list of Announcement Summary items in a tenancy. operationId: ListAnnouncements parameters: - $ref: '#/components/parameters/SummaryContainsQueryParam' - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AnnouncementSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of AnnouncementSummary. 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/AnnouncementCollection' 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: Retrieve Fleet Application Management announcements. tags: - fleetAppsManagement /fleets: get: description: 'Returns a list of all the Fleets in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListFleets parameters: - $ref: '#/components/parameters/FleetLifecycleStateQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FleetTypeQueryParam' - $ref: '#/components/parameters/ApplicationTypeQueryParam' - $ref: '#/components/parameters/ProductTypeQueryParam' - $ref: '#/components/parameters/EnvironmentTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/FleetIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FleetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of FleetSummary 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 opc-total-items: description: A number representing the the total number of results available. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/FleetCollection' 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 Fleets in a compartment tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetCollection' post: description: 'Create a fleet in Fleet Application Management. ' operationId: CreateFleet parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The Fleet 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 fleet, the fleet 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/Fleet' 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 Fleet. tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFleetDetails' description: Details for the new Fleet. required: true /fleets/actions/checkResourceTagging: post: description: 'Check if Fleet Application Management tags can be added to the resources. ' operationId: CheckResourceTagging parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Fleet Application Management tags added. 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/ResourceTagCheckDetails' 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: Check if Fleet Application Management tags can be added to the resources. tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckResourceTaggingDetails' description: Details for checking if Fleet Application Management tags can be added to the resources. required: true /fleets/{fleetId}: delete: description: Delete a fleet in Fleet Application Management. operationId: DeleteFleet parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Fleet 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 Fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' get: description: Get the details of a fleet in Fleet Application Management. operationId: GetFleet parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Fleet 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/Fleet' 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 tags: - fleetAppsManagement put: description: Update fleet information in Fleet Application Management. operationId: UpdateFleet parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated Fleet object. 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/Fleet' 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 Fleet identified by the id tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFleetDetails' description: The information to be updated. required: true /fleets/{fleetId}/actions/changeCompartment: post: description: 'Moves a Fleet 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: ChangeFleetCompartment parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Fleet 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 Fleet into a different compartment. tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeFleetCompartmentDetails' description: Details of the target compartment. required: true /fleets/{fleetId}/actions/confirmTargets: post: description: 'Confirm targets to be managed for a Fleet. Only targets that are confirmed will be managed by Fleet Application Management. ' operationId: ConfirmTargets parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 202: description: Accepted the request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Confirm targets to be managed for a Fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmTargetsDetails' description: Details for confirming Targets. required: true /fleets/{fleetId}/actions/generateComplianceReport: post: description: 'Generate compliance report for a Fleet. ' operationId: GenerateComplianceReport parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 202: description: Accepted the request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Request to generate Compliance Report for a Fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateComplianceReportDetails' description: Details for generating compliance report for the Fleet. required: true /fleets/{fleetId}/actions/requestResourceValidation: post: description: 'Request validation for resources within a fleet. ' operationId: RequestResourceValidation parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 202: description: Accepted the request.Resource validation initiated. 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Request validation for resources with in a fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestResourceValidationDetails' description: Details for requesting resource validation. required: true /fleets/{fleetId}/actions/requestTargetDiscovery: post: description: 'Request target discovery for resources with in a fleet. ' operationId: RequestTargetDiscovery parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 202: description: Accepted the request.Target discovery will be initiated. 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' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Request target discovery for resources with in a fleet. tags: - fleetAppsManagement x-related-resource: '#/definitions/Fleet' requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestTargetDiscoveryDetails' description: Details for requesting target discovery. required: true /fleets/{fleetId}/compliance: get: description: Retrieve compliance for a fleet. operationId: GetCompliance parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Compliance for the Fleet. 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/Compliance' 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: Retrieve a compliance tags: - fleetAppsManagement /fleets/{fleetId}/complianceReports/{complianceReportId}: get: description: Retrieve compliance report for a fleet. operationId: GetComplianceReport parameters: - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/ComplianceReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Compliance report for the Fleet. 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/ComplianceReport' 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: Retrieve a compliance report tags: - fleetAppsManagement /fleets/{fleetId}/fleetCredentials: get: description: 'List credentials associated with a fleet. ' operationId: ListFleetCredentials parameters: - $ref: '#/components/parameters/FleetCredentialLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/TargetQueryParam' - $ref: '#/components/parameters/CredentialLevelQueryParam' - $ref: '#/components/parameters/FleetCredentialIdentifierQueryParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FleetCredentialSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of FleetCredentialSummary 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/FleetCredentialCollection' 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 credentials associated with a fleet. tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetCredentialCollection' post: description: 'Add credentials to a fleet in Fleet Application Management. ' operationId: CreateFleetCredential parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 201: description: Accepted the request. The credential 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 fleetCredential, the fleetCredential 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/FleetCredential' 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 FleetCredential tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetCredential' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFleetCredentialDetails' description: Details for the new fleet credential. required: true /fleets/{fleetId}/fleetCredentials/{fleetCredentialId}: delete: description: Deletes a credential associated with a fleet or with a product/target with in a fleet. operationId: DeleteFleetCredential parameters: - $ref: '#/components/parameters/FleetCredentialIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Credential 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 credential specified by an identifier. tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetCredential' get: description: Gets a fleet credential by identifier. operationId: GetFleetCredential parameters: - $ref: '#/components/parameters/FleetCredentialIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The fleet credential with the specified identifier was retrieved 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/FleetCredential' 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 Credential. tags: - fleetAppsManagement put: description: Edit credential associated with a fleet or with a product/target with in a fleet. operationId: UpdateFleetCredential parameters: - $ref: '#/components/parameters/FleetCredentialIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The credential 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 FleetCredential specified by the identifier tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetCredential' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFleetCredentialDetails' description: The credential information to be updated. required: true /fleets/{fleetId}/fleetProducts: get: description: 'Returns a list of products associated with the confirmed targets. ' operationId: ListFleetProducts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/ResourceDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ProductSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 200: description: A page of FleetProductSummary 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/FleetProductCollection' 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 FleetProducts in a compartment tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetProductCollection' /fleets/{fleetId}/fleetProperties: get: description: 'List properties associated with a fleet. ' operationId: ListFleetProperties parameters: - $ref: '#/components/parameters/FleetPropertyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/FleetPropertyIdentifierQueryParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FleetPropertySortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of FleetPropertySummary 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/FleetPropertyCollection' 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 properties associated with a fleet. tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetPropertyCollection' post: description: 'Add an existing global property to a fleet in Fleet Application Management. ' operationId: CreateFleetProperty parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 200: description: Fleet 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/FleetProperty' 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 FleetProperty tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetProperty' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFleetPropertyDetails' description: Details for the new fleet property. required: true /fleets/{fleetId}/fleetProperties/{fleetPropertyId}: delete: description: Deletes a property associated with a fleet in Fleet Application Management. operationId: DeleteFleetProperty parameters: - $ref: '#/components/parameters/FleetPropertyIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The fleet property is deleted 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a fleet property tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetProperty' get: description: Gets a fleet property by identifier. operationId: GetFleetProperty parameters: - $ref: '#/components/parameters/FleetPropertyIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Fleet property 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/FleetProperty' 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 Property tags: - fleetAppsManagement put: description: Edit a property associated with a fleet in Fleet Application Management. operationId: UpdateFleetProperty parameters: - $ref: '#/components/parameters/FleetPropertyIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Fleet property updated. 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/FleetProperty' 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 fleet property specified by the identifier tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetProperty' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFleetPropertyDetails' description: Attributes to update a fleet property. required: true /fleets/{fleetId}/fleetResources: get: description: 'List resources for a fleet in Fleet Application Management. ' operationId: ListFleetResources parameters: - $ref: '#/components/parameters/FleetResourceLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/FleetResourceIdentifierQueryParam' - $ref: '#/components/parameters/FleetResourceTypeQueryParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FleetResourceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of FleetResourceSummary 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/FleetResourceCollection' 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 FleetResources in a compartment tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetResourceCollection' post: description: 'Add resource to a fleet in Fleet Application Management. ' operationId: CreateFleetResource parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetIdentifierPathParam' responses: 201: description: Accepted the request. The FleetResource 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 fleetResource, the fleetResource 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/FleetResource' 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 FleetResource tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetResource' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFleetResourceDetails' description: Details for the new fleet resource. required: true /fleets/{fleetId}/fleetResources/{fleetResourceId}: delete: description: Removes a resource from the fleet in Fleet Application Management. operationId: DeleteFleetResource parameters: - $ref: '#/components/parameters/FleetResourceIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The FleetResource 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 FleetResource specified by the identifier. tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetResource' get: description: Gets a fleet resource by identifier. operationId: GetFleetResource parameters: - $ref: '#/components/parameters/FleetResourceIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the FleetResource 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/FleetResource' 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 FleetResource tags: - fleetAppsManagement put: description: Updates the FleetResource. operationId: UpdateFleetResource parameters: - $ref: '#/components/parameters/FleetResourceIdentifierPathParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The FleetResource 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 FleetResource specified by the identifier. tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetResource' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFleetResourceDetails' description: The information to be updated. required: true /fleets/{fleetId}/fleetTargets: get: description: 'Returns the list of all confirmed targets within a fleet. ' operationId: ListFleetTargets parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProductQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/ResourceDisplayNameQueryParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TargetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FleetTargetLifecycleStateQueryParam' responses: 200: description: A page of FleetTargetSummary 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/FleetTargetCollection' 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 confirmed Targets for a Fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetTargetCollection' /fleets/{fleetId}/targets: get: description: 'Return all targets belonging to the resources within a fleet. It will include both confirmed and unconfirmed targets. ' operationId: ListTargets parameters: - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/FleetIdentifierPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsConfirmedTargetsQueryParam' responses: 200: description: A page of FleetTargetSummary 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/FleetTargetCollection' 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 Targets for a Fleet tags: - fleetAppsManagement x-related-resource: '#/definitions/FleetTargetCollection' /inventoryResources: get: description: 'Returns a list of Inventory Resources based on the criteria provided. instance, dbsystem, cloudvmcluster resources are supported. ' operationId: ListInventoryResources parameters: - $ref: '#/components/parameters/InventoryCompartmentIdQueryParam' - $ref: '#/components/parameters/InventoryResourceLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RegionQueryParam' - $ref: '#/components/parameters/ResourceCompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/InventoryPropertiesQueryParam' - $ref: '#/components/parameters/MatchingCriteriaQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/InventoryResourceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of InventoryResourceSummary 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/InventoryResourceCollection' 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 InventoryResources based on the criteria provided. tags: - fleetAppsManagement x-related-resource: '#/definitions/InventoryResourceCollection' components: schemas: NotificationPreference: description: Notification information to get notified when the fleet status changes. properties: compartmentId: description: Compartment ID the topic belongs to. maxLength: 255 minLength: 1 type: string preferences: $ref: '#/components/schemas/Preferences' topicId: description: 'Topic Id where the notifications will be directed. A topic is a communication channel for sending messages on chosen events to subscriptions. ' maxLength: 255 minLength: 1 type: string required: - topicId - compartmentId type: object ComplianceReportTarget: description: Details of the target and patches. properties: complianceState: description: The last known compliance state of the target. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' installedPatches: description: Installed Patches for the Target. items: $ref: '#/components/schemas/ComplianceReportPatchDetail' type: array recommendedPatches: description: Recommended Patches for the Target. items: $ref: '#/components/schemas/ComplianceReportPatchDetail' type: array targetId: description: Target Identifier.Can be the target name if a separate ID is not available. maxLength: 255 minLength: 1 type: string targetName: description: Target Name. maxLength: 255 minLength: 1 type: string version: description: Current version of the target. type: string required: - targetId - targetName - complianceState InventoryResourceCollection: description: Results of a inventoryResource search. Contains both InventoryResourceSummary items and other information, such as metadata. properties: items: description: List of InventoryResources. items: $ref: '#/components/schemas/InventoryResourceSummary' type: array required: - items type: object UpdateFleetPropertyDetails: description: The information to be updated for the fleet property. properties: value: description: Value of the Property. maxLength: 255 type: string x-default-description: 'null' 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 FleetDetails: description: Fleet Type discriminator: propertyName: fleetType properties: fleetType: description: 'Type of the Fleet. PRODUCT - A fleet of product-specific resources for a product type. ENVIRONMENT - A fleet of environment-specific resources for a product stack. GROUP - A fleet of a fleet of either environment or product fleets. GENERIC - A fleet of resources selected dynamically or manually for reporting purposes ' enum: - GENERIC - PRODUCT - ENVIRONMENT - GROUP type: string x-default-description: GENERIC type: object FleetResourceSummary: description: Summary of the FleetResource. properties: compartment: description: Resource Compartment name. type: string compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string complianceState: description: Compliance State of the Resource. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' 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 environmentType: description: 'Environment Type associated with the Fleet when the resource type is fleet. Will only be returned for ENVIRONMENT fleets that are part of a GROUP Fleet. ' maxLength: 255 type: string id: description: The unique id 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 FleetResource. type: string x-obmcs-enumref: '#/definitions/FleetResource/lifecycleState' percentCompliant: description: The compliance percentage. format: float type: number product: description: 'Product associated with the resource when the resource type is fleet. Will only be returned for PRODUCT fleets that are part of a GROUP Fleet. ' maxLength: 255 type: string productCount: description: Count of products within the resource. type: integer resourceId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' resourceType: description: Type of the Resource. 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 targetCount: description: Count of targets within the resource. type: integer tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string tenancyName: description: Resource Tenancy Name. 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 required: - id - resourceId - tenancyId - compartmentId - resourceType - lifecycleState - timeCreated - displayName type: object FleetTargetCollection: description: Results of a fleetTarget search. Contains both FleetTargetSummary items and other information, such as metadata. properties: items: description: List of fleetTargets. items: $ref: '#/components/schemas/FleetTargetSummary' type: array required: - items type: object FleetSummary: description: 'Summary of a Fleet.A fleet is a collection or grouping of resources based on criteria. ' 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 details: $ref: '#/components/schemas/FleetDetails' 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 environmentType: description: 'Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. ' maxLength: 255 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 lifecycle state of the Fleet. type: string x-obmcs-enumref: '#/definitions/Fleet/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 required: - id - compartmentId - lifecycleState - timeCreated - displayName type: object GenerateComplianceReportDetails: description: 'Request to generate compliance report for the fleet. ' properties: areDetailsRequired: description: 'A value that specifies if compliance details are required at the target level also? Allowed values are N and Y. ' type: string TargetResource: description: Resource Information for the Target. properties: resourceDisplayName: 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 resourceId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string type: object UpdateFleetDetails: 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 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 environmentType: description: 'Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. ' maxLength: 255 minLength: 1 type: string x-default-description: 'null' 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 isTargetAutoConfirm: description: 'A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. ' type: boolean notificationPreferences: description: 'Notification Preferences associated with the Fleet. An UPDATE operation replaces the existing notification preferences list entirely ' items: $ref: '#/components/schemas/NotificationPreference' maxItems: 20 type: array products: description: 'Products associated with the Fleet. Provide PlatformConfiguration Ids corresponding to all the Products that need to be managed. ' items: type: string maxItems: 30 type: array resourceSelection: $ref: '#/components/schemas/ResourceSelection' type: object CreateFleetPropertyDetails: description: The information about new Property to manage fleet metadata details. properties: propertyId: description: OCID referring to global level metadata property. maxLength: 255 minLength: 1 type: string value: description: Value of the Property. maxLength: 255 type: string x-default-description: 'null' required: - value - propertyId type: object CredentialDetails: description: Credential Details. discriminator: propertyName: credentialType properties: credentialType: description: Credential Type. enum: - PLAIN_TEXT - VAULT_SECRET - KEY_ENCRYPTION type: string required: - credentialType type: object DiscoveredTarget: description: 'A target that is discovered by the Software discovery process. ' properties: operation: description: 'Type of operation to be done against given target. ADD - Add target. REMOVE - Delete target. ' enum: - ADD - REMOVE type: string x-default-description: ADD product: description: Product that the target belongs to. maxLength: 255 minLength: 1 type: string resourceId: description: Unique key that identifies the resource that the target belongs to. maxLength: 255 minLength: 1 type: string targetId: description: ID of the Target. Can be the target name if a separate ID is not available. maxLength: 255 minLength: 1 type: string targetName: description: Target Name. maxLength: 255 minLength: 1 type: string version: description: Current version of the target. maxLength: 255 type: string x-default-description: 'null' required: - targetId - targetName - product - resourceId RequestTargetDiscoveryDetails: description: 'Request to initiate target discovery. ' properties: isApplicableToAllResources: default: true description: A boolean flag that decides if all resources within the fleet should be part of discovery. type: boolean resourceIds: description: Resource OCIDS to be included for discovery. items: type: string maxItems: 500 type: array ConfirmTargetsDetails: description: 'Details of the targets to be confirmed for Fleet Application Management. ' properties: targets: description: The targets to confirm. items: $ref: '#/components/schemas/DiscoveredTarget' maxItems: 32768 type: array required: - targets Fleet: description: 'A fleet is a collection or grouping of resources based on criteria. ' properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string credentials: description: Credentials associated with the Fleet. items: $ref: '#/components/schemas/AssociatedFleetCredentialDetails' maxItems: 500 type: array 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 details: $ref: '#/components/schemas/FleetDetails' 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 environmentType: description: 'Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. ' maxLength: 255 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 isTargetAutoConfirm: default: false description: 'A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. ' type: boolean 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 lifecycle state of the Fleet. enum: - ACTIVE - INACTIVE - CREATING - DELETED - DELETING - FAILED - UPDATING - NEEDS_ATTENTION type: string notificationPreferences: description: Notification Preferences associated with the Fleet. items: $ref: '#/components/schemas/NotificationPreference' maxItems: 20 type: array parentFleetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the fleet that would be the parent for this fleet. ' maxLength: 255 minLength: 1 type: string products: description: 'Products associated with the Fleet. PlatformConfiguration Ids corresponding to the Products. ' items: type: string maxItems: 30 type: array properties: description: Properties associated with the Fleet. items: $ref: '#/components/schemas/AssociatedFleetPropertyDetails' maxItems: 100 type: array resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' resourceSelection: $ref: '#/components/schemas/ResourceSelection' resources: description: Resources associated with the Fleet if resourceSelectionType is MANUAL. items: $ref: '#/components/schemas/AssociatedFleetResourceDetails' maxItems: 500 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 - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object FleetResourceCollection: description: Results of a fleetResource search. Contains both FleetResourceSummary items and other information, such as metadata. properties: items: description: List of fleetResources. items: $ref: '#/components/schemas/FleetResourceSummary' type: array required: - items type: object FleetTargetSummary: description: Summary of a confirmed target within a fleet. properties: compartmentId: description: compartment OCID maxLength: 255 minLength: 1 type: string complianceState: description: The last known compliance state of the target. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' 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 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isLastDiscoveryAttemptSuccessful: description: A boolean flag that represents whether the last discovery attempt was successful. type: boolean lifecycleState: description: The current state of the FleetTarget. type: string x-obmcs-enumref: '#/definitions/FleetTarget/lifecycleState' parentTargetName: description: Name of the parent target. type: string product: description: Product to which the target belongs to. maxLength: 255 type: string resource: $ref: '#/components/schemas/TargetResource' 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 timeOfLastDiscoveryAttempt: description: The time when last discovery was attempted. format: date-time type: string timeOfLastSuccessfulDiscovery: description: The time when the last successful discovery was made. format: date-time type: string version: description: Current version of target. maxLength: 255 type: string required: - id - displayName type: object ComplianceReport: description: Compliance details for a fleet in Fleet Application Management. properties: complianceState: description: The last known compliance state of the fleet. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' fleetId: description: The fleet OCID. maxLength: 255 minLength: 1 type: string id: description: Compliance Report Identifier maxLength: 255 minLength: 1 type: string percentCompliant: description: The compliance percentage. format: float type: number resources: description: Resources associated with the Fleet. items: $ref: '#/components/schemas/ComplianceReportResource' type: array required: - fleetId - complianceState - id FleetCredentialCollection: description: Results of a fleetCredential search. Contains boh FleetCredentialSummary items and other information, such as metadata. properties: items: description: List of fleetCredentials. items: $ref: '#/components/schemas/FleetCredentialSummary' type: array required: - items type: object AssociatedFleetCredentialDetails: description: The information about associated FleetCredential. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 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 entitySpecifics: $ref: '#/components/schemas/CredentialEntitySpecificDetails' password: $ref: '#/components/schemas/CredentialDetails' user: $ref: '#/components/schemas/CredentialDetails' required: - compartmentId - displayName - user - password - entitySpecifics type: object ComplianceReportProduct: description: Details of the Product. properties: productName: description: Product Name. maxLength: 255 minLength: 1 type: string targets: description: Managed Targets associated with the Product. items: $ref: '#/components/schemas/ComplianceReportTarget' type: array required: - productName AssociatedFleetResourceDetails: description: The information about associated FleetResource. properties: compartmentId: description: Compartment Identifier[OCID]. type: string fleetResourceType: description: Type of the FleetResource. type: string resourceId: description: OCID of the resource. maxLength: 255 minLength: 1 type: string tenancyId: description: Tenancy Identifier[OCID]. maxLength: 255 minLength: 1 type: string required: - resourceId - tenancyId - compartmentId type: object FleetProductCollection: description: Results of a fleetProduct search. Contains boh FleetProductSummary items and other information, such as metadata. properties: items: description: List of fleetProducts. items: $ref: '#/components/schemas/FleetProductSummary' type: array required: - items type: object CreateFleetDetails: description: The information about new Fleet. properties: compartmentId: description: compartment OCID maxLength: 255 minLength: 1 type: string credentials: description: Credentials associated with the Fleet. items: $ref: '#/components/schemas/AssociatedFleetCredentialDetails' maxItems: 500 type: array 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 details: $ref: '#/components/schemas/FleetDetails' 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 environmentType: description: 'Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types. ' maxLength: 255 type: string x-default-description: 'null' 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 isTargetAutoConfirm: default: false description: 'A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention. ' type: boolean notificationPreferences: description: Notification Preferences associated with the Fleet. items: $ref: '#/components/schemas/NotificationPreference' maxItems: 20 type: array parentFleetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the fleet that would be the parent for this fleet. ' maxLength: 255 minLength: 1 type: string products: description: 'Products associated with the Fleet. Provide PlatformConfiguration Ids corresponding to all the Products that need to be managed. ' items: type: string maxItems: 30 type: array properties: description: Properties associated with the Fleet. items: $ref: '#/components/schemas/AssociatedFleetPropertyDetails' maxItems: 100 type: array resourceSelection: $ref: '#/components/schemas/ResourceSelection' resources: description: Resources associated with the Fleet if resourceSelectionType is MANUAL. items: $ref: '#/components/schemas/AssociatedFleetResourceDetails' maxItems: 500 type: array required: - compartmentId - displayName - resourceSelection type: object AnnouncementSummary: description: A summary of announcements for Fleet Application Management. properties: announcementEnd: description: Announcement end date. format: date-time type: string announcementStart: description: Announcement start date. format: date-time type: string 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 description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string details: description: Announcement details. maxLength: 62000 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 lifecycleState: description: The lifecycle state of the announcement. enum: - ACTIVE - INACTIVE - DELETED - FAILED type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' summary: description: Summary of the announcement. maxLength: 1024 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 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: Type of announcement. maxLength: 200 type: string url: description: URL to the announcement. maxLength: 400 type: string required: - id - compartmentId - summary - announcementStart - announcementEnd - type type: object ResourceTagEnablementInfo: description: Resource tag enablement Information. properties: isTaggingPossible: default: true description: A value that represents if the resource can be tagged with a Fleet name. type: boolean resourceId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string required: - resourceId - isTaggingPossible UpcomingSchedule: description: Enables notification on upcoming schedule. properties: notifyBefore: description: 'Specify when the notification should be sent. ' format: x-obmcs-duration type: string onUpcomingSchedule: default: false description: Enables notification on upcoming schedule. type: boolean type: object FleetResource: description: Resource added to a fleet in Fleet Application Management. properties: compartment: description: Resource Compartment name. type: string compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string complianceState: description: Compliance State of the Resource. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' 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 environmentType: description: 'Environment Type associated with the Fleet when the resource type is fleet. Will only be returned for ENVIRONMENT fleets that are part of a GROUP Fleet. ' maxLength: 255 type: string id: description: The unique id 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 FleetResource. enum: - ACTIVE - DELETED - FAILED - NEEDS_ATTENTION type: string percentCompliant: description: The compliance percentage. format: float type: number product: description: 'Product associated with the resource when the resource type is fleet. Will only be returned for PRODUCT fleets that are part of a GROUP Fleet. ' maxLength: 255 type: string productCount: description: Count of products within the resource. type: integer resourceId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' resourceType: description: Type of the Resource. 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 targetCount: description: Count of targets within the resource. type: integer tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string tenancyName: description: Resource Tenancy Name. 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 required: - id - resourceId - tenancyId - compartmentId - resourceType - lifecycleState - timeCreated - displayName type: object FleetProperty: description: Property to manage fleet metadata details in Fleet Application Management. properties: allowedValues: description: Values of the property (must be a single value if selectionType = 'SINGLE_CHOICE'). items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 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 id: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the FleetProperty. enum: - ACTIVE - DELETED - FAILED type: string propertyId: description: OCID referring to global level metadata property. maxLength: 255 minLength: 1 type: string selectionType: 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 value: description: Value of the Property. maxLength: 255 type: string valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' required: - id - compartmentId - displayName - valueType - selectionType - lifecycleState - timeCreated type: object FleetCollection: description: Results of a fleet search. Contains both FleetSummary items and other information, such as metadata. properties: items: description: List of fleets. items: $ref: '#/components/schemas/FleetSummary' type: array required: - items type: object FleetProductSummary: description: Summary of a product associated with a Fleet. properties: compartmentId: description: Root Compartment Id. maxLength: 255 minLength: 1 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 resource: $ref: '#/components/schemas/TargetResource' 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 targetCount: description: Count of the targets associated with the Product. type: integer required: - displayName - resource type: object AnnouncementCollection: description: Results of list announcements. Contains AnnouncementSummary items. properties: items: description: List of AnnouncementSummary items. items: $ref: '#/components/schemas/AnnouncementSummary' type: array required: - items type: object FleetPropertySummary: description: Summary of the FleetProperty. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 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 id: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the FleetProperty. type: string x-obmcs-enumref: '#/definitions/FleetProperty/lifecycleState' propertyId: description: OCID referring to global level metadata property. maxLength: 255 minLength: 1 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 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 value: description: Value of the Property. maxLength: 255 type: string valueType: description: Format of the value. enum: - STRING - NUMERIC type: string x-obmcs-top-level-enum: '#/definitions/ValueType' required: - id - compartmentId - propertyId - valueType - lifecycleState - timeCreated - displayName type: object FleetCredential: description: Credential in Fleet Application Management. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 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 entitySpecifics: $ref: '#/components/schemas/CredentialEntitySpecificDetails' id: description: The unique id 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 FleetCredential. enum: - ACTIVE - DELETED - FAILED type: string password: $ref: '#/components/schemas/CredentialDetails' 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 user: $ref: '#/components/schemas/CredentialDetails' required: - id - displayName - lifecycleState - timeCreated - compartmentId - entitySpecifics type: object FleetPropertyCollection: description: Results of a fleetProperty search. Contains both FleetPropertySummary items and other information, such as metadata. properties: items: description: List of fleet properties in Fleet Application Management. items: $ref: '#/components/schemas/FleetPropertySummary' type: array required: - items type: object UpdateFleetResourceDetails: description: The information to be updated for the resource. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string type: object ComplianceReportPatchDetail: description: Details of the Patch. properties: patchDescription: description: Patch description. maxLength: 255 minLength: 1 type: string patchName: description: Patch name. maxLength: 255 minLength: 1 type: string patchType: description: Type of patch. maxLength: 255 minLength: 1 type: string timeApplied: description: Time the patch was applied. format: date-time type: string timeReleased: description: The date on which patch was released. format: date-time type: string required: - patchName - patchType UpdateFleetCredentialDetails: description: The information to be updated. properties: 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 entitySpecifics: $ref: '#/components/schemas/CredentialEntitySpecificDetails' password: $ref: '#/components/schemas/CredentialDetails' user: $ref: '#/components/schemas/CredentialDetails' type: object AssociatedFleetPropertyDetails: description: The information about associated FleetProperty. properties: compartmentId: description: compartment OCID maxLength: 255 minLength: 1 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 fleetPropertyType: description: Type of the FleetProperty. enum: - STRING - NUMBER type: string isRequired: default: false description: Property is required or not. type: boolean value: description: Value of the Property. maxLength: 255 type: string required: - fleetPropertyType - compartmentId type: object RequestResourceValidationDetails: description: 'Request to initiate resource validation. ' properties: isApplicableToAllResources: default: true description: A boolean flag that decides if all resources within the fleet should be part of the validation. type: boolean resourceIds: description: Resource OCIDS to be included for validation. items: type: string maxItems: 500 type: array CheckResourceTaggingDetails: description: Request to check resource tagging. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 type: string fleetDisplayName: description: Fleet Display Name. maxLength: 255 minLength: 1 type: string resourceIds: description: Resource OCIDS that need to be verified if a tag can be enabled for them. items: type: string maxItems: 500 type: array required: - resourceIds - compartmentId FleetCredentialSummary: description: Summary of the FleetCredential. properties: compartmentId: description: Compartment OCID maxLength: 255 minLength: 1 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 entitySpecifics: $ref: '#/components/schemas/CredentialEntitySpecificDetails' id: description: The unique id 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 FleetCredential. type: string x-obmcs-enumref: '#/definitions/FleetCredential/lifecycleState' password: $ref: '#/components/schemas/CredentialDetails' 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 user: $ref: '#/components/schemas/CredentialDetails' required: - id - lifecycleState - timeCreated - displayName - entitySpecifics type: object Compliance: description: Compliance Summary properties: complianceState: description: Compliance State. maxLength: 255 minLength: 1 type: string confirmedTargetCount: description: Confirmed Target Count. format: int32 type: integer nonCompliantTargetCount: description: Non Compliant Target Count. format: int32 type: integer required: - complianceState - confirmedTargetCount - nonCompliantTargetCount type: object ComplianceReportResource: description: Details of the Resource properties: compartment: description: Compartment the resource belongs to. maxLength: 255 minLength: 1 type: string complianceState: description: The last known compliance state of the fleet. enum: - UNKNOWN - COMPLIANT - NON_COMPLIANT - WARNING type: string x-obmcs-top-level-enum: '#/definitions/ComplianceState' products: description: "Products associated with the Fleet. \nOnly the products belonging to managed targets will be shown.\n" items: $ref: '#/components/schemas/ComplianceReportProduct' type: array resourceId: description: The OCID to identify the resource. maxLength: 255 minLength: 1 type: string resourceName: description: Display name of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: The region the resource belongs to. maxLength: 255 minLength: 1 type: string resourceType: description: Type of the resource. type: string tenancyId: description: TenancyId of the resource. maxLength: 255 minLength: 1 type: string tenancyName: description: Tenancy the resource belongs to. maxLength: 255 minLength: 1 type: string required: - resourceId - resourceName - resourceType - complianceState ResourceTagCheckDetails: description: Request to check resource tagging. properties: tagEnablementInfo: description: Tag enablement Information for the resources. items: $ref: '#/components/schemas/ResourceTagEnablementInfo' type: array required: - tagEnablementInfo InventoryResourceSummary: description: InventoryResource Search Summary. properties: availabilityDomain: description: Availability Domain of the resource. maxLength: 255 minLength: 1 type: string 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 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 Resource. type: string resourceCompartmentId: description: Compartment Id of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: The region the resource belongs to. maxLength: 200 minLength: 1 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 type: description: Type of the Resource. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - type - lifecycleState - displayName - freeformTags - definedTags type: object ChangeFleetCompartmentDetails: 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 Fleet to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CredentialEntitySpecificDetails: description: Credential specific Details. discriminator: propertyName: credentialLevel properties: credentialLevel: description: At what level the credential is provided? enum: - FLEET - RESOURCE - TARGET type: string required: - credentialLevel type: object CreateFleetCredentialDetails: description: The information about new FleetCredential. properties: 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 entitySpecifics: $ref: '#/components/schemas/CredentialEntitySpecificDetails' password: $ref: '#/components/schemas/CredentialDetails' user: $ref: '#/components/schemas/CredentialDetails' required: - displayName - user - password - entitySpecifics type: object ResourceSelection: description: Resource Selection Type discriminator: propertyName: resourceSelectionType properties: resourceSelectionType: description: 'Type of resource selection in a Fleet. Select resources manually or select resources based on rules. ' enum: - DYNAMIC - MANUAL type: string x-default-description: MANUAL required: - resourceSelectionType type: object CreateFleetResourceDetails: description: The information about the resource to be added to the fleet. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string resourceId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' resourceType: description: Type of the Resource. type: string tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string required: - resourceId - tenancyId - compartmentId type: object Preferences: description: Preferences to send notifications on the fleet activities. properties: onJobCanceled: default: false description: Enables or disables notification on job canceled. type: boolean onJobFailure: default: false description: Enables or disables notification on Job Failures. type: boolean onJobScheduleChange: default: false description: Enables or disables notification on job schedule change. type: boolean onJobStart: default: false description: Enables or disables notification on job start. type: boolean onJobSuccess: default: false description: Enables or disables notification on job success. type: boolean onResourceNonCompliance: default: false description: Enables or disables notification when fleet resource becomes non compliant. type: boolean onRunbookNewerVersion: default: false description: Enables or disables notification when a newer version of runbook associated with a fleet is available type: boolean onTaskFailure: default: false description: Enables or disables notification on task failure. type: boolean onTaskPause: default: false description: Enables or disables notification when a task is paused. type: boolean onTaskSuccess: default: false description: Enables or disables notification on task success. type: boolean onTopologyModification: default: false description: Enables or disables notification on Environment Fleet Topology Modification. type: boolean upcomingSchedule: $ref: '#/components/schemas/UpcomingSchedule' type: object parameters: FleetIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single fleet by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string FleetResourceSortByQueryParam: 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/FleetResourceSortBy' schema: type: string enum: - timeCreated - displayName 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 InventoryCompartmentIdQueryParam: description: A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string FleetResourceTypeQueryParam: description: A filter to return only resources whose resourceType matches the given resourceType. in: query name: fleetResourceType x-default-description: 'null' 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 InventoryResourceLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' schema: type: string FleetIdentifierPathParam: description: Unique Fleet identifier. in: path name: fleetId required: true schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string InventoryResourceSortByQueryParam: 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.\n \n" in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/InventoryResourceSortBy' schema: type: string enum: - timeCreated - displayName ProductSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for displayName and resourceDisplayName is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/ProductSortBy' schema: type: string enum: - displayName - resourceDisplayName default: displayName AnnouncementSortByQueryParam: description: 'The field to sort AnnouncementSummary by. Only one sort order may be provided. If no value is specified timeReleased is default. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/AnnouncementSortBy' schema: type: string enum: - timeReleased - summary default: timeReleased 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 ResourceIdentifierQueryParam: description: Resource Identifier in: query name: resourceId x-default-description: 'null' schema: type: string FleetLifecycleStateQueryParam: description: A filter to return fleets whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Fleet/lifecycleState' schema: type: string 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 FleetCredentialLifecycleStateQueryParam: 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/FleetCredential/lifecycleState' schema: type: string ProductTypeQueryParam: description: A filter to return resources that match the Product/Product Stack given. in: query name: product x-default-description: 'null' schema: type: string FleetResourceIdentifierPathParam: description: unique FleetResource identifier in: path name: fleetResourceId required: true schema: type: string FleetPropertySortByQueryParam: 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/FleetPropertySortBy' schema: type: string enum: - timeCreated - displayName MatchingCriteriaQueryParam: description: 'Fetch resources matching ANY or ALL criteria passed as params in "tags" and "inventoryProperties". Example: matchingCriteria=ANY ' in: query name: matchingCriteria x-default-description: 'null' schema: type: string ResourceCompartmentIdQueryParam: description: A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID. in: query name: resourceCompartmentId required: true x-default-description: 'null' schema: type: string FilterByFreeformTagEqualsQueryParam: description: 'A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND". ' in: query name: freeformTagEquals required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 357 type: string FleetResourceIdentifierQueryParam: description: A filter to return only resources whose identifier matches the given identifier. in: query name: id x-default-description: 'null' 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 FleetPropertyIdentifierPathParam: description: Unique fleetProperty identifier. in: path name: fleetPropertyId required: true 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 FleetSortByQueryParam: 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/FleetSortBy' schema: type: string enum: - timeCreated - displayName RegionQueryParam: description: Resource Region in: query name: resourceRegion x-default-description: 'null' schema: type: string FleetPropertyLifecycleStateQueryParam: 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/FleetProperty/lifecycleState' schema: type: string FleetTargetLifecycleStateQueryParam: description: A filter to return fleets whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/FleetTarget/lifecycleState' schema: type: string FleetCredentialIdentifierQueryParam: description: A filter to return only resources whose credential identifier matches the given identifier. in: query name: id x-default-description: 'null' schema: type: string ComplianceReportIdPathParam: description: compliance report identifier. in: path name: complianceReportId required: true schema: type: string TargetSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for displayName,product and resourceDisplayName is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/TargetSortBy' schema: type: string enum: - displayName - product - resourceDisplayName default: displayName EnvironmentTypeQueryParam: description: A filter to return resources that match the Environment Type given. in: query name: environmentType x-default-description: 'null' schema: type: string FleetCredentialIdentifierPathParam: description: unique FleetCredential identifier in: path name: fleetCredentialId required: true schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing 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 ApplicationTypeQueryParam: description: A filter to return resources that match the Application Type/Product Stack given.. in: query name: applicationType x-default-description: 'null' schema: type: string FleetPropertyIdentifierQueryParam: description: A filter to return only resources whose fleetProperty identifier matches the given identifier. in: query name: id x-default-description: 'null' schema: type: string FleetResourceLifecycleStateQueryParam: 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/FleetResource/lifecycleState' schema: type: string ProductQueryParam: description: Product Name. in: query name: product x-default-description: 'null' schema: type: string FleetTypeQueryParam: description: A filter to return fleets whose fleetType matches the given fleetType. in: query name: fleetType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/FleetDetails/fleetType' schema: type: string InventoryPropertiesQueryParam: description: 'A list of inventory properties filters to apply. The key for each inventory property and value for each resource type is "{resourceType}.{inventoryProperty}={value}". Example: Instance.displayName=TEST_INSTANCE ' in: query name: inventoryProperties required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string FilterByDefinedTagEqualsQueryParam: description: 'A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}={value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". Example: Identification.Development=Yes ' in: query name: definedTagEquals required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 458 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 IsConfirmedTargetsQueryParam: description: 'If set to true, confirmed targets will be returned. ' in: query name: isConfirmedTargets required: false schema: type: boolean default: false ResourceDisplayNameQueryParam: description: Resource Display Name. in: query name: resourceDisplayName x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 FleetCredentialSortByQueryParam: 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/FleetCredentialSortBy' schema: type: string enum: - timeCreated - displayName CredentialLevelQueryParam: description: A filter to return only resources whose credentialLevel matches the given credentialLevel. in: query name: credentialLevel x-default-description: 'null' x-obmcs-enumref: '#/definitions/CredentialEntitySpecificDetails/credentialLevel' schema: type: string TargetQueryParam: description: A filter to return only resources whose target matches the given target name. in: query name: target x-default-description: 'null' schema: type: string SummaryContainsQueryParam: description: 'Filter the list of announcements that contains the given summary value. ' in: query name: summaryContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 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