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 Catalog 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: fleetAppsManagementCatalog paths: /catalogItems: get: description: 'Gets a list of Catalog Items in a compartment. ' operationId: ListCatalogItems parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/ConfigSourceTypeQueryParam' - $ref: '#/components/parameters/CatalogLifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CatalogItemSortByQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CatalogListingIdQueryParam' - $ref: '#/components/parameters/CatalogListingVersionCriteriaQueryParam' - $ref: '#/components/parameters/CatalogPackageTypeQueryParam' - $ref: '#/components/parameters/ShouldListPublicItemsQueryParam' responses: 200: description: A page of CatalogItem Summary 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/CatalogItemCollection' 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 Catalog Items in a compartment. tags: - fleetAppsManagementCatalog x-related-resource: '#/definitions/CatalogItemCollection' post: description: 'Creates a CatalogItem. ' operationId: CreateCatalogItem parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The CatalogItem is being 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 CatalogItem. The catalogItem 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/CatalogItem' 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 CatalogItem. tags: - fleetAppsManagementCatalog x-related-resource: '#/definitions/CatalogItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCatalogItemDetails' description: Details for the new CatalogItem. required: true /catalogItems/{catalogItemId}: delete: description: Deletes a CatalogItem. operationId: DeleteCatalogItem parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The CatalogItem is being 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 CatalogItem. tags: - fleetAppsManagementCatalog x-related-resource: '#/definitions/CatalogItem' get: description: Gets information about a CatalogItem. operationId: GetCatalogItem parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list CatalogItem is being 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/CatalogItem' 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 CatalogItem. tags: - fleetAppsManagementCatalog put: description: Updates a CatalogItem. operationId: UpdateCatalogItem parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The CatalogItem is being 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a CatalogItem. tags: - fleetAppsManagementCatalog x-related-resource: '#/definitions/CatalogItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCatalogItemDetails' description: The information to be updated. required: true /catalogItems/{catalogItemId}/actions/changeCompartment: post: description: 'Moves a CatalogItem 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: ChangeCatalogItemCompartment parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The CatalogItem 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 CatalogItem into a different compartment. tags: - fleetAppsManagementCatalog x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/CatalogItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCatalogItemCompartmentDetails' description: Details of the target compartment. required: true /catalogItems/{catalogItemId}/actions/cloneCatalogItem: post: description: 'Clones a CatalogItem 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: CloneCatalogItem parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The CatalogItem will be cloned into a different compartment. 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 CatalogItem. The catalogItem 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/CatalogItem' 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: Clones a CatalogItem into a different compartment. tags: - fleetAppsManagementCatalog x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/CatalogItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneCatalogItemDetails' description: The information to be updated. required: true /catalogItems/{catalogItemId}/actions/configure: post: description: 'Configures a CatalogItem. Creating new Catalog Item. ' operationId: ConfigureCatalogItem parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. New CatalogItem with the configuration 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 CatalogItem. The catalogItem 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/CatalogItem' 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: Configures a CatalogItem, creating new Catalog Item tags: - fleetAppsManagementCatalog x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/CatalogItem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureCatalogItemDetails' description: The information to be updated. required: true /catalogItems/{catalogItemId}/variablesDefinitions: get: description: Gets information about a CatalogItem Variables. operationId: GetCatalogItemVariablesDefinition parameters: - $ref: '#/components/parameters/CatalogItemIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Variable Definitions list is being 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/CatalogItemVariablesDefinition' 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 CatalogItem Variables Definitions. tags: - fleetAppsManagementCatalog x-related-resource: '#/definitions/CatalogItemVariablesDefinition' components: schemas: CatalogResultPayload: description: 'Catalog result payload. ' discriminator: propertyName: configResultType properties: configResultType: description: 'config result type. ' enum: - PAR_RESULT_CONFIG - TEMPLATE_RESULT_CONFIG - GIT_RESULT_CONFIG type: string workingDirectory: description: 'working directory ' maxLength: 255 minLength: 1 type: string required: - configResultType StackSource: additionalProperties: false description: Object representing the source information for the stack, indicating origin type and a reference string. properties: reference: description: Reference string providing a pointer or identifier for the source. maxLength: 512 minLength: 1 type: string type: description: The source type of the stack (e.g. MARKETPLACE, QUICKSTART, or WEB). enum: - MARKETPLACE - QUICKSTART - WEB type: string type: object ConfigureCatalogItemDetails: description: Contains the details required to configure a catalog item. properties: bucketName: description: The name of the Object Storage bucket that contains the catalog item configuration object. maxLength: 255 minLength: 1 type: string x-default-description: 'null' catalogListingId: description: The unique identifier of the catalog listing to which configuration applies. maxLength: 25 minLength: 0 type: string x-default-description: 'null' catalogListingVersionId: description: The unique identifier for the specific version of the catalog listing. maxLength: 25 minLength: 0 type: string x-default-description: 'null' compartmentId: description: OCID of the Compartment. maxLength: 255 minLength: 1 type: string x-default-description: 'null' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object inputVariables: description: Array of key value pairs specifying variables or parameters to be used when configuring the catalog item. items: $ref: '#/components/schemas/KeyValueProperty' maxItems: 100 type: array x-default-description: 'null' objectName: description: The name of the object file in the specified bucket containing catalog item configuration details. maxLength: 255 minLength: 0 type: string x-default-description: 'null' storageNamespace: description: The Oracle Cloud Object Storage namespace where the artifact or variables are stored. maxLength: 255 minLength: 1 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 required: - compartmentId - storageNamespace - bucketName - inputVariables type: object CatalogItemCollection: description: The results of a CatalogItem search containing list of CatalogItemSummary items properties: items: description: List of CatalogItems. items: $ref: '#/components/schemas/CatalogItemSummary' type: array required: - items type: object VariableGroups: description: variable groups object. properties: array: additionalProperties: $ref: '#/components/schemas/VariableGroup' description: Map of group names to their respective VariableGroup objects. type: object type: object VariableGroup: additionalProperties: true description: An organizational grouping of related variables within the schema. properties: title: description: Display title for the group of variables. maxLength: 255 minLength: 1 type: string variables: description: Array of variable references assigned to this group. items: format: variablereference type: string maxItems: 100 type: array visible: description: Hint controlling the group's visibility. maxLength: 255 minLength: 1 type: string required: - title - variables 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 SchemaDocument: additionalProperties: true description: Schema Document representing Schema.yaml (/iaas/Content/ResourceManager/Concepts/terraformconfigresourcemanager_topic-schema.htm) properties: canAllowViewState: description: Indicates if the stack allows users to view state information. type: boolean description: description: A detailed description of the stack or schema. maxLength: 255 minLength: 1 type: string groupings: $ref: '#/components/schemas/VariableGroups' informationalText: description: Informational text or notes relevant to the stack or its use. maxLength: 4096 minLength: 1 type: string instructions: description: Setup or usage instructions for this stack. maxLength: 4096 minLength: 1 type: string locale: default: EN description: The locale/language for the schema user interface (default is EN). enum: - EN type: string logoUrl: description: logo url. maxLength: 1024 minLength: 1 pattern: ^https?://(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,4}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)$ type: string outputGroups: description: Array of output group objects to group outputs for display or logical purposes. items: $ref: '#/components/schemas/OutputGroup' maxItems: 100 type: array outputs: additionalProperties: $ref: '#/components/schemas/BaseOutput' description: A mapping of output variable names to their definitions. type: object packageVersion: description: The version of the package associated with this schema. maxLength: 255 minLength: 1 type: string primaryOutputButton: description: primary output button value. maxLength: 512 minLength: 1 type: string schemaVersion: description: The version of the schema definition format in use for this document. enum: - V_1_0_0 - V_1_1_0 type: string source: $ref: '#/components/schemas/StackSource' stackDescription: description: Additional details describing the stack's purpose or use-case. maxLength: 255 minLength: 1 type: string title: description: The display name or title for this schema document. maxLength: 255 minLength: 1 type: string troubleshooting: description: Troubleshooting tips, guidance, or steps for stack usage. maxLength: 2048 minLength: 1 type: string variableGroups: description: An array of variable group definitions for organizing variables together. items: $ref: '#/components/schemas/VariableGroup' maxItems: 100 type: array variables: additionalProperties: $ref: '#/components/schemas/BaseVariable' description: Key-value map of input variables defined for use by the stack. type: object version: description: The version identifier for this schema document. maxLength: 255 minLength: 1 type: string required: - variables - schemaVersion title: Schema type: object BaseVariable: description: Base definition for a schema variable, including common metadata such as type, title, description, and validation constraints. discriminator: propertyName: type properties: description: description: Detailed information about this variable's purpose and usage. maxLength: 255 minLength: 1 type: string isRequired: default: false description: Indicates if this input variable is required for stack execution. type: boolean title: description: The display name for the variable as shown in the UI. maxLength: 255 minLength: 1 type: string type: description: Type of the variable. enum: - ARRAY - BOOLEAN - ENUM - INTEGER - NUMBER - STRING - TEXT - FILE - PASSWORD - DATETIME - DUMMY - OCI_IDENTITY_DOMAINS_ID - OCI_CORE_IMAGE_ID - OCI_CORE_INSTANCESHAPEWITHFLEX_NAME - OCI_CORE_INSTANCESHAPE_NAME - OCI_CORE_NATGATEWAY_ID - OCI_CORE_INSTANCE_ID - OCI_CORE_SUBNET_ID - OCI_CORE_SERVICEGATEWAY_ID - OCI_LOGAN_LOGGROUP_ID - OCI_LOGAN_SCHEDULEDTASK_ID - OCI_LOGAN_LOGENTITY_ID - OCI_LOGAN_ENTITYTYPE_ID - OCI_MGMT_AGENT_ID - OCI_LOGAN_SOURCE_ID - OCI_CORE_NSG_ID - OCI_CORE_VCN_ID - OCI_IDENTITY_AVAILABILITYDOMAIN_NAME - OCI_IDENTITY_COMPARTMENT_ID - OCI_IDENTITY_FAULTDOMAIN_NAME - OCI_IDENTITY_REGION_NAME - OCI_DATABASE_DBSYSTEM_ID - OCI_DATABASE_DBHOME_ID - OCI_DATABASE_DBHOME_DBVERSION - OCI_DATABASE_DATABASE_ID - OCI_DATABASE_AUTONOMOUSDATABASE_ID - OCI_DATABASE_AUTONOMOUSDATABASEVERSION_ID - OCI_DATABASE_AUTONOMOUSCONTAINERDATABASE_ID - OCI_KMS_KEY_ID - OCI_KMS_SECRET_ID - OCI_CONTAINER_CLUSTER_ID - OCI_KUBERNETES_VERSIONS_ID - OCI_BLOCKSTORAGE_POLICIES_ID - OCI_IDENTITY_GROUPS_ID - OCI_IDENTITY_DYNAMICGROUPS_ID - OCI_LOADBALANCER_LOADBALANCER_ID - OCI_MOUNT_TARGET_ID - OCI_IDENTITY_TAG_VALUE - OCI_ODS_PROJECT_ID - OCI_RESOURCEMANAGER_PRIVATEENDPOINT_ID - OCI_APM_DOMAIN_ID - OCI_CORE_SSH_PUBLICKEY - OCI_KMS_VAULT_ID - OCI_LOADBALANCER_NETWORKLOADBALANCER_ID - OCI_LOADBALANCER_LOADBALANCER_RESERVEDIPS_ID - OCI_DATABASE_MYSQL_SHAPE_ID - OCI_DATABASE_MYSQL_CONFIGURATION_ID - OCI_STORAGE_FILESTORAGE_EXPORTSET_ID - OCI_STORAGE_FILESTORAGE_FILESYSTEM_ID - OCI_STORAGE_OBJECTSTORAGE_BUCKET_NAME - OCI_CORE_VCN_SECLIST_ID - OCI_CORE_VOLUME_ID - OCI_DATABASE_DATAGUARD_ID - OCI_DATABASE_EXADATA_ID - OCI_DATABASE_CLOUDVMCLUSTER_ID - OCI_DATABASE_CDB_ID - OCI_DATABASE_DATAGUARDASSOCIATION_ID - OCI_DATABASE_DBNODE_ID - OCI_CORE_VCN_NETWORKSECURITYGROUP_ID - OCI_STORAGE_FILESTORAGE_MOUNTTARGET_ID type: string visible: description: Hint to control whether this variable is visible. maxLength: 255 minLength: 1 type: string required: - type type: object BaseOutput: additionalProperties: true description: Base output. discriminator: propertyName: type properties: description: description: Extended help or summary for understanding output. maxLength: 255 minLength: 1 type: string format: description: Hint about formatting or rendering the output value. maxLength: 255 minLength: 1 type: string isSensitive: default: false description: If true, marks this output as sensitive. type: boolean title: description: Output label shown to the user. maxLength: 255 minLength: 1 type: string type: description: Data type of the output value (such as STRING, NUMBER, OCID, etc). enum: - ARRAY - BOOLEAN - NUMBER - STRING - COPYABLESTRING - MAP - LIST - JSON - CSV - LINK - OCID type: string visible: default: true description: Expression to show/hide this output. maxLength: 255 minLength: 1 type: string type: object CloneCatalogItemDetails: description: The configuration details for the clone operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to clone the CatalogItem to ' maxLength: 255 minLength: 1 type: string versionDescription: description: Version description about the catalog item. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ChangeCatalogItemCompartmentDetails: 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 CatalogItem to ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateCatalogItemDetails: description: The data to create a CatalogItem. properties: catalogSourcePayload: $ref: '#/components/schemas/CatalogSourcePayload' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string configSourceType: description: 'Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. ' type: string x-obmcs-enumref: '#/definitions/CatalogItem/configSourceType' 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: 'The description of the CatalogItem. ' maxLength: 4095 minLength: 1 type: string displayName: description: The CatalogItem name. 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 isItemLocked: default: false description: Indicates if the CatalogItem is immutable or not. type: boolean listingId: description: 'The catalog listing Id. ' maxLength: 255 minLength: 1 type: string listingVersion: description: 'The catalog package version. ' maxLength: 255 minLength: 1 type: string packageType: description: 'Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE. ' type: string x-obmcs-enumref: '#/definitions/CatalogItem/packageType' shortDescription: description: Short description about the catalog item. maxLength: 511 minLength: 1 type: string timeReleased: description: 'The date and time the CatalogItem was released, 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 versionDescription: description: Version description about the catalog item. maxLength: 255 minLength: 1 type: string required: - compartmentId - configSourceType - description - displayName - packageType type: object UpdateCatalogItemDetails: description: The data to update a CatalogItem. 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: 'The description of the CatalogItem. ' maxLength: 4095 minLength: 1 type: string displayName: description: The CatalogItem name. 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 isItemLocked: default: false description: Indicates if the CatalogItem is immutable or not. type: boolean shortDescription: description: Short description about the catalog item. maxLength: 511 minLength: 1 type: string versionDescription: description: Version description about the catalog item. maxLength: 255 minLength: 1 type: string type: object CatalogItemSummary: description: Summary information about a CatalogItem. properties: catalogResultPayload: $ref: '#/components/schemas/CatalogResultPayload' catalogSourcePayload: $ref: '#/components/schemas/CatalogSourcePayload' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string configSourceType: description: 'Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. ' type: string x-obmcs-enumref: '#/definitions/CatalogItem/configSourceType' 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: The description of the catalogItem. maxLength: 4095 minLength: 1 type: string 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 id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the catalog. type: string isItemLocked: default: false description: Indicates if the CatalogItem is immutable or not. type: boolean lifecycleDetails: description: The details of lifecycle state CatalogItem. type: string lifecycleState: description: The current state of the CatalogItem. type: string x-obmcs-enumref: '#/definitions/CatalogItem/lifecycleState' listingId: description: 'The catalog listing Id. ' maxLength: 255 minLength: 1 type: string listingVersion: description: 'The catalog package version. ' maxLength: 255 minLength: 1 type: string packageType: description: 'Config package type Eg: BASE_PACKAGE, EXTENSION_PACKAGE. ' type: string x-obmcs-enumref: '#/definitions/CatalogItem/packageType' shortDescription: description: Short description about the catalog item. maxLength: 511 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 CatalogItem 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 timeReleased: description: 'The date and time the CatalogItem was released, 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 CatalogItem 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 versionDescription: description: Version description about the catalog item. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - configSourceType - description - listingId - listingVersion - displayName - lifecycleState - lifecycleDetails - packageType - timeCreated - timeUpdated - versionDescription - shortDescription - timeReleased type: object CatalogItemVariablesDefinition: description: Variables Definitions for a CatalogItem. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object schemaDocument: $ref: '#/components/schemas/SchemaDocument' 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 required: - schemaDocument type: object CatalogItem: description: 'A description of a CatalogItem resource. 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: catalogResultPayload: $ref: '#/components/schemas/CatalogResultPayload' catalogSourcePayload: $ref: '#/components/schemas/CatalogSourcePayload' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string configSourceType: description: 'Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. ' enum: - PAR_CATALOG_SOURCE - GIT_CATALOG_SOURCE - MARKETPLACE_CATALOG_SOURCE - STACK_TEMPLATE_CATALOG_SOURCE 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: Description about the catalog item. maxLength: 4095 minLength: 1 type: string 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 id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the catalog. type: string isItemLocked: default: false description: Indicates if the CatalogItem is immutable or not. type: boolean lifecycleDetails: description: The details of lifecycle state CatalogItem. type: string lifecycleState: description: The current state of the CatalogItem. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string listingId: description: 'The catalog listing Id. ' maxLength: 255 minLength: 1 type: string listingVersion: description: 'The catalog package version. ' maxLength: 255 minLength: 1 type: string packageType: description: 'Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE. ' enum: - TF_PACKAGE - NON_TF_PACKAGE - CONFIG_FILE type: string shortDescription: description: Short description about the catalog item. maxLength: 511 minLength: 1 type: string shouldListPublicItems: default: false description: The indicator to append Public Items from the root compartment to any query, when set to TRUE. type: boolean 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 timeBackfillLastChecked: description: 'The date and time the CatalogItem was last checked by backfill job, 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 timeCreated: description: 'The date and time the CatalogItem 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 timeLastChecked: description: 'The date and time the CatalogItem was last checked, 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 timeReleased: description: 'The date and time the CatalogItem was released, 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 CatalogItem 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 versionDescription: description: Version description about the catalog item. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - configSourceType - description - listingId - listingVersion - displayName - lifecycleState - lifecycleDetails - packageType - timeCreated - timeUpdated type: object CatalogSourcePayload: description: Catalog source payload. discriminator: propertyName: configSourceType properties: configSourceType: description: 'config source type. ' type: string x-obmcs-enumref: '#/definitions/CatalogItem/configSourceType' workingDirectory: description: 'File path to the directory to use for running Terraform. If not specified, the root directory is used. ' maxLength: 255 minLength: 1 type: string required: - configSourceType type: object OutputGroup: additionalProperties: true description: Output group. properties: outputs: description: Array of output strings included in group. items: type: string type: array title: description: Display name for group of outputs. maxLength: 255 minLength: 1 type: string required: - title - outputs type: object KeyValueProperty: description: Key Value Property to set for configuration. Please check LandingZoneSummary.packageVariables output from /landingZones API for a list of valid properties. properties: key: description: Name of the configuration variable or property to set for the catalog item. maxLength: 255 minLength: 1 type: string value: description: The value assigned to the specified configuration property key. maxLength: 255 minLength: 1 type: string required: - key - value type: object parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: page schema: type: string minLength: 1 CatalogPackageTypeQueryParam: description: "A filter to return only resources that match the given package type. The\nstate value is case-insensitive. \n" in: query name: packageType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/CatalogItem/packageType' schema: type: string CatalogItemSortByQueryParam: description: 'The field to sort by. You can provide only one sort by. Default value for `timeCreated` is descending. Default order for `displayName` is ascending ' in: query name: sortBy x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/CatalogItemSortBy' schema: type: string enum: - timeCreated - displayName - timeBackfillLastChecked CatalogLifecycleStateQueryParam: 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/CatalogItem/lifecycleState' 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 CatalogListingIdQueryParam: description: catalogListingId of the package. This is an integer whose min and max length are specified. in: query name: catalogListingId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 MandatoryCompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string CatalogListingVersionCriteriaQueryParam: description: Parameter to list all catalog items only with latest version or list all catalog items with all versions. in: query name: catalogListingVersionCriteria x-default-description: LIST_ALL_VERSIONS x-obmcs-top-level-enum: '#/definitions/CatalogListingVersionCriteriaEnum' schema: type: string enum: - LIST_ALL_VERSIONS - LIST_EARLIEST_VERSION_ONLY - LIST_LATEST_VERSION_ONLY maxLength: 255 minLength: 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 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 CatalogItemIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CatalogItem. in: path name: catalogItemId required: true schema: type: string ShouldListPublicItemsQueryParam: description: The indicator to append Public Items from the root compartment to any query, when set to TRUE. in: query name: shouldListPublicItems required: false x-default-description: 'null' schema: type: boolean default: false 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 ConfigSourceTypeQueryParam: description: 'The [ConfigSourceType](/definitions/CatalogItem/configSourceType) Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE. ' in: query name: configSourceType 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