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 Provision 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: fleetAppsManagementProvision paths: /provisions: get: description: 'Returns a list of all the Provisions in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` or `fleetId` is specified. ' operationId: ListProvisions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ProvisionLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ProvisionIdentifierQueryParam' - $ref: '#/components/parameters/AssociatedFleetIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ProvisionSummary 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/ProvisionCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Provisions. tags: - fleetAppsManagementProvision x-related-resource: '#/definitions/ProvisionCollection' post: description: 'Creates a Provision. ' operationId: CreateProvision parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The Provision 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 famProvision. The famProvision OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Provision' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a Provision. tags: - fleetAppsManagementProvision x-related-resource: '#/definitions/Provision' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProvisionDetails' description: Details for the new Provision. required: true /provisions/{provisionId}: delete: description: Deletes a Provision. operationId: DeleteProvision parameters: - $ref: '#/components/parameters/ProvisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Provision 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 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/DefaultError' summary: Deletes a Provision. tags: - fleetAppsManagementProvision x-related-resource: '#/definitions/Provision' get: description: Gets information about a Provision. operationId: GetProvision parameters: - $ref: '#/components/parameters/ProvisionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Provision was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Provision' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Provision tags: - fleetAppsManagementProvision put: description: Updates a Provision. operationId: UpdateProvision parameters: - $ref: '#/components/parameters/ProvisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Provision 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 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/DefaultError' summary: Updates a Provision. tags: - fleetAppsManagementProvision x-related-resource: '#/definitions/Provision' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProvisionDetails' description: The information to be updated. required: true /provisions/{provisionId}/actions/changeCompartment: post: description: 'Moves a Provision 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: ChangeProvisionCompartment parameters: - $ref: '#/components/parameters/ProvisionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Provision 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' default: $ref: '#/components/responses/DefaultError' summary: Moves a Provision into a different compartment. tags: - fleetAppsManagementProvision x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Provision' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeProvisionCompartmentDetails' description: Details of the target compartment. required: true components: schemas: InstanceSummary: description: InstanceSummary contains info regarding deployed instances. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which instance is deployed. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance. maxLength: 255 minLength: 1 type: string state: description: Instance lifecycle state maxLength: 255 minLength: 1 type: string required: - id - compartmentId - state type: object JobExecutionDetails: description: The Apply job output variable properties: isSensitive: description: The indicator if the data for this parameter is sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) maxLength: 255 minLength: 1 type: boolean outputDescription: description: The output description maxLength: 255 minLength: 1 type: string outputName: description: The output name maxLength: 255 minLength: 1 type: string outputType: description: The output type maxLength: 255 minLength: 1 type: string outputValue: description: The output value maxLength: 255 minLength: 1 type: string required: - outputName - outputType - outputValue 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 DeployedResourceDetails: description: The Filtered List Of Deployed Resources properties: mode: description: 'The mode of the resource. Example: "managed"' maxLength: 255 minLength: 1 type: string resourceInstanceList: description: Collection of InstanceSummary items: $ref: '#/components/schemas/InstanceSummary' type: array resourceName: description: The name of the resource maxLength: 255 minLength: 1 type: string resourceProvider: description: The name of the Provider maxLength: 255 minLength: 1 type: string resourceType: description: 'The provider resource type. Must be supported by the [Oracle Cloud Infrastructure provider](https://registry.terraform.io/providers/oracle/oci/latest/docs). Example: oci_core_instance ' maxLength: 255 minLength: 1 type: string required: - mode - resourceName - resourceProvider - resourceType - resourceInstanceList type: object ProvisionSummary: description: Summary information about a FamProvision. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string configCatalogItemDisplayName: description: A display Name of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string configCatalogItemId: description: A [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. maxLength: 255 minLength: 1 type: string configCatalogItemListingId: description: A listing ID of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string configCatalogItemListingVersion: description: A listing version of the Catalog Item in the Catalog. 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. maxLength: 255 minLength: 1 type: string fleetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. 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](/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the FamProvision in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the FamProvision. type: string x-obmcs-enumref: '#/definitions/Provision/lifecycleState' packageCatalogItemDisplayName: description: A display Name of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string packageCatalogItemId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. maxLength: 255 minLength: 1 type: string packageCatalogItemListingId: description: A listing ID of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string packageCatalogItemListingVersion: description: A listing version of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string provisionDescription: description: A description of the provision. maxLength: 255 minLength: 1 type: string stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RMS Stack. 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 date and time the FamProvision was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the FamProvision was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - provisionDescription - packageCatalogItemId - configCatalogItemId - packageCatalogItemDisplayName - packageCatalogItemListingId - packageCatalogItemListingVersion - configCatalogItemDisplayName - configCatalogItemListingId - configCatalogItemListingVersion - fleetId - stackId - freeformTags - definedTags type: object UpdateProvisionDetails: description: The data to update a FamProvision. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. 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 provisionDescription: description: A description of the provision. maxLength: 255 minLength: 1 type: string type: object ProvisionCollection: description: Results of a famProvision search. Contains both FamProvisionSummary items and other information, such as metadata. properties: items: description: List of famProvisions. items: $ref: '#/components/schemas/ProvisionSummary' maxItems: 100 type: array required: - items type: object Provision: description: 'A FamProvision is a description of a FamProvision. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string configCatalogItemDisplayName: description: A display Name of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string configCatalogItemId: description: A [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. maxLength: 255 minLength: 1 type: string configCatalogItemListingId: description: A listing ID of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string configCatalogItemListingVersion: description: A listing version of the Catalog Item in the Catalog. 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 deployedResources: description: The deployed resources and their summary items: $ref: '#/components/schemas/DeployedResourceDetails' maxItems: 100 type: array x-default-description: 'null' displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string fleetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. 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](/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the FamProvision in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' type: string lifecycleState: description: The current state of the FamProvision. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string packageCatalogItemDisplayName: description: A display Name of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string packageCatalogItemId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. maxLength: 255 minLength: 1 type: string packageCatalogItemListingId: description: A listing ID of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string packageCatalogItemListingVersion: description: A listing version of the Catalog Item in the Catalog. maxLength: 255 minLength: 1 type: string provisionDescription: description: A description of the provision. maxLength: 255 minLength: 1 type: string rmsApplyJobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RMS APPLY Job. maxLength: 255 minLength: 1 type: string stackId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RMS Stack. 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 tfOutputs: description: Outputs from the Terraform Apply job items: $ref: '#/components/schemas/JobExecutionDetails' type: array tfVariableCompartmentId: description: An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableCurrentUserId: description: An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableRegionId: description: A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableTenancyId: description: A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the FamProvision was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the FamProvision was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - packageCatalogItemId - configCatalogItemId - packageCatalogItemDisplayName - packageCatalogItemListingId - packageCatalogItemListingVersion - configCatalogItemDisplayName - configCatalogItemListingId - configCatalogItemListingVersion - fleetId - tfVariableTenancyId - tfVariableRegionId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object CreateProvisionDetails: description: The data to create a FamProvision. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the FamProvision in. ' maxLength: 255 minLength: 1 type: string configCatalogItemId: description: A [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item to a file with key/value pairs to set up variables for createStack API. 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. maxLength: 255 minLength: 1 type: string fleetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Fleet. 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 packageCatalogItemId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Catalog Item. maxLength: 255 minLength: 1 type: string provisionDescription: description: A description of the provision. maxLength: 255 minLength: 1 type: string tfVariableCompartmentId: description: An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableCurrentUserId: description: An optional variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableRegionId: description: A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string tfVariableTenancyId: description: A mandatory variable added to a list of RMS variables for createStack API. Overrides the one supplied in configuration file. maxLength: 255 minLength: 1 type: string required: - compartmentId - packageCatalogItemId - configCatalogItemId - fleetId - tfVariableTenancyId - tfVariableRegionId type: object ChangeProvisionCompartmentDetails: 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 FamProvision to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object parameters: 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 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 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 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 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 AssociatedFleetIdentifierQueryParam: description: unique Fleet identifier in: query name: fleetId x-default-description: 'null' schema: type: string ProvisionIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the FamProvision. in: path name: provisionId 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 ProvisionLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Provision/lifecycleState' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string ProvisionIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single provision by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: Unique identifier for the request 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