{ "opencollection": "1.0.0", "info": { "name": "Fleet Application Management Service Fleet Apps Management API", "version": "20250228" }, "items": [ { "info": { "name": "fleetAppsManagement", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Fleet Application Management announcements.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/announcements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "summaryContains", "value": "", "type": "query", "description": "Filter the list of announcements that contains the given summary value.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort AnnouncementSummary by. Only one sort order may be provided.\nIf no value is specified timeReleased is default.\n" } ] }, "docs": "Return a list of Announcement Summary items in a tenancy." }, { "info": { "name": "Gets a list of all Fleets in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return fleets whose lifecycleState matches the given lifecycleState." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\nEmpty only if the resource OCID query param is not specified.\n" }, { "name": "fleetType", "value": "", "type": "query", "description": "A filter to return fleets whose fleetType matches the given fleetType." }, { "name": "applicationType", "value": "", "type": "query", "description": "A filter to return resources that match the Application Type/Product Stack given.." }, { "name": "product", "value": "", "type": "query", "description": "A filter to return resources that match the Product/Product Stack given." }, { "name": "environmentType", "value": "", "type": "query", "description": "A filter to return resources that match the Environment Type given." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single fleet by id.\nEither compartmentId or id must be provided.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Returns a list of all the Fleets in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new Fleet.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a fleet in Fleet Application Management.\n" }, { "info": { "name": "Check if Fleet Application Management tags can be added to the resources.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/actions/checkResourceTagging", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Check if Fleet Application Management tags can be added to the resources.\n" }, { "info": { "name": "Get Fleet", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Get the details of a fleet in Fleet Application Management." }, { "info": { "name": "Update the Fleet identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/fleets/:fleetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update fleet information in Fleet Application Management." }, { "info": { "name": "Delete a provisioned Fleet", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/fleets/:fleetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Delete a fleet in Fleet Application Management." }, { "info": { "name": "Moves a Fleet into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Fleet into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Confirm targets to be managed for a Fleet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/actions/confirmTargets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Confirm targets to be managed for a Fleet.\nOnly targets that are confirmed will be managed by Fleet Application Management.\n" }, { "info": { "name": "Request to generate Compliance Report for a Fleet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/actions/generateComplianceReport", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate compliance report for a Fleet.\n" }, { "info": { "name": "Request validation for resources with in a fleet", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/actions/requestResourceValidation", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request validation for resources within a fleet.\n" }, { "info": { "name": "Request target discovery for resources with in a fleet.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/actions/requestTargetDiscovery", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request target discovery for resources with in a fleet.\n" }, { "info": { "name": "Retrieve a compliance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/compliance", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Retrieve compliance for a fleet." }, { "info": { "name": "Retrieve a compliance report", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/complianceReports/:complianceReportId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "complianceReportId", "value": "", "type": "path", "description": "compliance report identifier." } ] }, "docs": "Retrieve compliance report for a fleet." }, { "info": { "name": "Gets a list of credentials associated with a fleet.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetCredentials", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "resourceId", "value": "", "type": "query", "description": "Resource Identifier" }, { "name": "target", "value": "", "type": "query", "description": "A filter to return only resources whose target matches the given target name." }, { "name": "credentialLevel", "value": "", "type": "query", "description": "A filter to return only resources whose credentialLevel matches the given credentialLevel." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources whose credential identifier matches the given identifier." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "List credentials associated with a fleet.\n" }, { "info": { "name": "Creates a new FleetCredential", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetCredentials", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add credentials to a fleet in Fleet Application Management.\n" }, { "info": { "name": "Get Fleet Credential.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetCredentials/:fleetCredentialId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetCredentialId", "value": "", "type": "path", "description": "unique FleetCredential identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Gets a fleet credential by identifier." }, { "info": { "name": "Update the FleetCredential specified by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetCredentials/:fleetCredentialId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetCredentialId", "value": "", "type": "path", "description": "unique FleetCredential identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit credential associated with a fleet or with a product/target with in a fleet." }, { "info": { "name": "Deletes a credential specified by an identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetCredentials/:fleetCredentialId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetCredentialId", "value": "", "type": "path", "description": "unique FleetCredential identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Deletes a credential associated with a fleet or with a product/target with in a fleet." }, { "info": { "name": "Gets a list of all FleetProducts in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProducts", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources.\nEmpty only if the resource OCID query param is not specified.\n" }, { "name": "resourceId", "value": "", "type": "query", "description": "Resource Identifier" }, { "name": "resourceDisplayName", "value": "", "type": "query", "description": "Resource Display Name." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName and resourceDisplayName is ascending.\n" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Returns a list of products associated with the confirmed targets.\n" }, { "info": { "name": "Gets a list of properties associated with a fleet.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProperties", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources whose fleetProperty identifier matches the given identifier." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "List properties associated with a fleet.\n" }, { "info": { "name": "Creates a new FleetProperty", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProperties", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an existing global property to a fleet in Fleet Application Management.\n" }, { "info": { "name": "Get Fleet Property", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProperties/:fleetPropertyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetPropertyId", "value": "", "type": "path", "description": "Unique fleetProperty identifier." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Gets a fleet property by identifier." }, { "info": { "name": "Update the fleet property specified by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProperties/:fleetPropertyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetPropertyId", "value": "", "type": "path", "description": "Unique fleetProperty identifier." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit a property associated with a fleet in Fleet Application Management." }, { "info": { "name": "Delete a fleet property", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetProperties/:fleetPropertyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetPropertyId", "value": "", "type": "path", "description": "Unique fleetProperty identifier." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Deletes a property associated with a fleet in Fleet Application Management." }, { "info": { "name": "Gets a list of all FleetResources in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "A filter to return only resources whose identifier matches the given identifier." }, { "name": "fleetResourceType", "value": "", "type": "query", "description": "A filter to return only resources whose resourceType matches the given resourceType." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "List resources for a fleet in Fleet Application Management.\n" }, { "info": { "name": "Creates a new FleetResource", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetResources", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add resource to a fleet in Fleet Application Management.\n" }, { "info": { "name": "Get FleetResource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetResources/:fleetResourceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetResourceId", "value": "", "type": "path", "description": "unique FleetResource identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Gets a fleet resource by identifier." }, { "info": { "name": "Update the FleetResource specified by the identifier.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetResources/:fleetResourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetResourceId", "value": "", "type": "path", "description": "unique FleetResource identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the FleetResource." }, { "info": { "name": "Delete a FleetResource specified by the identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetResources/:fleetResourceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetResourceId", "value": "", "type": "path", "description": "unique FleetResource identifier" }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." } ] }, "docs": "Removes a resource from the fleet in Fleet Application Management." }, { "info": { "name": "Gets a list of all confirmed Targets for a Fleet", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/fleetTargets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "product", "value": "", "type": "query", "description": "Product Name." }, { "name": "resourceId", "value": "", "type": "query", "description": "Resource Identifier" }, { "name": "resourceDisplayName", "value": "", "type": "query", "description": "Resource Display Name." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for displayName,product and resourceDisplayName is ascending.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return fleets whose lifecycleState matches the given lifecycleState." } ] }, "docs": "Returns the list of all confirmed targets within a fleet.\n" }, { "info": { "name": "Gets a list of all Targets for a Fleet", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/fleets/:fleetId/targets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "fleetId", "value": "", "type": "path", "description": "Unique Fleet identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" }, { "name": "isConfirmedTargets", "value": "", "type": "query", "description": "If set to true, confirmed targets will be returned.\n" } ] }, "docs": "Return all targets belonging to the resources within a fleet.\nIt will include both confirmed and unconfirmed targets.\n" }, { "info": { "name": "Gets a list of all InventoryResources based on the criteria provided.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/inventoryResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "resourceRegion", "value": "", "type": "query", "description": "Resource Region" }, { "name": "resourceCompartmentId", "value": "", "type": "query", "description": "A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID." }, { "name": "definedTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.\nEach item in the list has the format \"{namespace}.{tagName}={value}\". All inputs are case-insensitive.\nMultiple values for the same key (i.e. same namespace and tag name) are interpreted as \"OR\".\nValues for different keys (i.e. different namespaces, different tag names, or both) are interpreted as \"AND\".\nExample: Identification.Development=Yes\n" }, { "name": "freeformTagEquals", "value": "", "type": "query", "description": "A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.\nThe key for each tag is \"{tagName}.{value}\". All inputs are case-insensitive.\nMultiple values for the same tag name are interpreted as \"OR\". Values for different tag names are interpreted as \"AND\".\n" }, { "name": "inventoryProperties", "value": "", "type": "query", "description": "A list of inventory properties filters to apply.\nThe key for each inventory property and value for each resource type is \"{resourceType}.{inventoryProperty}={value}\".\nExample: Instance.displayName=TEST_INSTANCE\n" }, { "name": "matchingCriteria", "value": "", "type": "query", "description": "Fetch resources matching ANY or ALL criteria passed as params in \"tags\" and \"inventoryProperties\".\nExample: matchingCriteria=ANY\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Returns a list of Inventory Resources based on the criteria provided.\ninstance, dbsystem, cloudvmcluster resources are supported.\n" } ] } ], "bundled": true }