{ "opencollection": "1.0.0", "info": { "name": "Fleet Application Management Service Fleet Apps Management Operations API", "version": "20250228" }, "items": [ { "info": { "name": "fleetAppsManagementOperations", "type": "folder" }, "items": [ { "info": { "name": "Retrieve aggregated summary information of ComplianceRecords within a Compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/complianceRecordCounts", "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\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'." } ] }, "docs": "Retrieve aggregated summary information of ComplianceRecords within a Compartment.\n" }, { "info": { "name": "Gets a list of complianceDetails.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/complianceRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "resourceId", "value": "", "type": "query", "description": "Resource identifier." }, { "name": "entityId", "value": "", "type": "query", "description": "Entity identifier.Ex:FleetId" }, { "name": "productName", "value": "", "type": "query", "description": "Product Name." }, { "name": "productStack", "value": "", "type": "query", "description": "ProductStack name." }, { "name": "targetName", "value": "", "type": "query", "description": "Unique target name" }, { "name": "complianceState", "value": "", "type": "query", "description": "Target Compliance State." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\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": "Gets a list of complianceDetails.\n" }, { "info": { "name": "Generate Compliance Report", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/complianceRecords/actions/exportComplianceReport", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate Compliance Report\n" }, { "info": { "name": "Gets a list of installed patches.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/installedPatches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "targetId", "value": "", "type": "query", "description": "Target Id." }, { "name": "targetName", "value": "", "type": "query", "description": "Target name." }, { "name": "severity", "value": "", "type": "query", "description": "Patch severity." }, { "name": "patchLevel", "value": "", "type": "query", "description": "Patch level." }, { "name": "patchType", "value": "", "type": "query", "description": "Patch Type." }, { "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.\n" } ] }, "docs": "Gets a list of installed patches.\nCompartmentId should be the compartmentId of resource(Containing the target).\n" }, { "info": { "name": "Gets a list of inventoryDetails.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/inventoryRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\n" }, { "name": "fleetId", "value": "", "type": "query", "description": "unique Fleet identifier" }, { "name": "resourceId", "value": "", "type": "query", "description": "Resource 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": "isDetailsRequired", "value": "", "type": "query", "description": "If set to true, inventory details will be returned.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\n" } ] }, "docs": "Gets a list of inventoryDetails.\n" }, { "info": { "name": "Retrieve aggregated summary information of Managed entities within a Compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/managedEntityCounts", "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\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'." } ] }, "docs": "Retrieve aggregated summary information of Managed entities within a Compartment.\n" }, { "info": { "name": "Gets a list of all Patches in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/patches", "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": "productId", "value": "", "type": "query", "description": "Product platformConfigurationId associated with the Patch." }, { "name": "version", "value": "", "type": "query", "description": "Product version." }, { "name": "type", "value": "", "type": "query", "description": "DefinedBy type." }, { "name": "patchTypeId", "value": "", "type": "query", "description": "Patch Type platformConfigurationId associated with the Patch." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Patch by id.\nEither compartmentId or id must be provided.\n" }, { "name": "timeReleasedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "A filter to return patches whose release date is greater than or equal to the given date." }, { "name": "timeReleasedLessThan", "value": "", "type": "query", "description": "A filter to return patches whose release date is less than the given date." }, { "name": "shouldCompliancePolicyRulesBeApplied", "value": "", "type": "query", "description": "Filter patch based on compliance policy rules for the Product." }, { "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": "lifecycleState", "value": "", "type": "query", "description": "The current state of the Patch." }, { "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 name is ascending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a list of all the Patches in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new Patch", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/patches", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Patch.\n" }, { "info": { "name": "Get Patch", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/patches/:patchId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "patchId", "value": "", "type": "path", "description": "Unique Patch identifier." } ] }, "docs": "Gets a Patch by identifier." }, { "info": { "name": "Update the Patch specified by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/patches/:patchId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "patchId", "value": "", "type": "path", "description": "Unique Patch identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the patch specified by the identifier." }, { "info": { "name": "Delete an existing Patch", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/patches/:patchId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "patchId", "value": "", "type": "path", "description": "Unique Patch identifier." } ] }, "docs": "Deletes the patch specified by identifier." }, { "info": { "name": "Moves a Patch into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/patches/:patchId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "patchId", "value": "", "type": "path", "description": "Unique Patch identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Patch 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": "Gets a list of recommended patches.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/recommendedPatches", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "targetId", "value": "", "type": "query", "description": "Target identifier." }, { "name": "targetName", "value": "", "type": "query", "description": "Unique target name" }, { "name": "patchLevel", "value": "", "type": "query", "description": "Patch level." }, { "name": "severity", "value": "", "type": "query", "description": "Patch severity." }, { "name": "patchType", "value": "", "type": "query", "description": "Patch Type." }, { "name": "patchId", "value": "", "type": "query", "description": "Patch 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.\n" } ] }, "docs": "Gets a list of recommended patches.\n" }, { "info": { "name": "Report", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/reports/actions/summarize", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Report\n" }, { "info": { "name": "Gets a list of Report Metadata", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/reports/metadata", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "reportName", "value": "", "type": "query", "description": "A filter to return data for given report name." }, { "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 report metadata.\n" }, { "info": { "name": "Gets a list of all SchedulerDefinitions in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerDefinitions", "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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only scheduleDefinitions 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": "product", "value": "", "type": "query", "description": "A filter to return only dchedule definitions whose assocaited product matches the given product" }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Schedule Definition by id.\nEither compartmentId or id must be provided.\n" }, { "name": "maintenanceWindowId", "value": "", "type": "query", "description": "A filter to return only schedule definitions whose associated maintenanceWindowId matches the given maintenanceWindowId." }, { "name": "runbookId", "value": "", "type": "query", "description": "A filter to return only schedule definitions whose associated runbookId matches the given runbookId." }, { "name": "runbookVersionName", "value": "", "type": "query", "description": "RunbookVersion Name filter" }, { "name": "timeScheduledGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "timeScheduledLessThan", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "fleetId", "value": "", "type": "query", "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 and timeOfNextRun is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all the Schedule Definitions in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new SchedulerDefinition", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/schedulerDefinitions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a SchedulerDefinition to perform lifecycle operations.\n" }, { "info": { "name": "Get SchedulerDefinition", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerDefinitions/:schedulerDefinitionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerDefinitionId", "value": "", "type": "path", "description": "unique SchedulerDefinition identifier" } ] }, "docs": "Get the details of a SchedulerDefinition that performs lifecycle management operations." }, { "info": { "name": "Update the SchedulerDefinition identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/schedulerDefinitions/:schedulerDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerDefinitionId", "value": "", "type": "path", "description": "unique SchedulerDefinition identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of a SchedulerDefinition that performs lifecycle management operations." }, { "info": { "name": "Delete a provisioned SchedulerDefinition", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/schedulerDefinitions/:schedulerDefinitionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerDefinitionId", "value": "", "type": "path", "description": "unique SchedulerDefinition identifier" } ] }, "docs": "Deletes a SchedulerDefinition resource by identifier" }, { "info": { "name": "Gets a list of all Fleets for a Schedule Definition", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerDefinitions/:schedulerDefinitionId/scheduledFleets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerDefinitionId", "value": "", "type": "path", "description": "unique SchedulerDefinition identifier" }, { "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 is ascending.\n" } ] }, "docs": "Returns a list of ScheduledFleets.\n" }, { "info": { "name": "Gets a list of all executions that are scheduled", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerExecutions", "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": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "timeScheduledGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "timeScheduledLessThan", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "schedulerDefintionId", "value": "", "type": "query", "description": "SchedulerDefinition identifier" }, { "name": "schedulerJobId", "value": "", "type": "query", "description": "SchedulerJob identifier filter" }, { "name": "resourceId", "value": "", "type": "query", "description": "ResourceId filter (Example FleetId)" }, { "name": "runbookId", "value": "", "type": "query", "description": "A filter to return only schedule definitions whose associated runbookId matches the given runbookId." }, { "name": "runbookVersionName", "value": "", "type": "query", "description": "RunbookVersion Name filter" }, { "name": "substate", "value": "", "type": "query", "description": "A filter to return only resources their subState matches the given subState." }, { "name": "lifecycleOperation", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleOperation matches the given lifecycleOperation." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\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 and timeScheduled is descending.\n" } ] }, "docs": "Returns a list of all executions that are scheduled.\n" }, { "info": { "name": "Retrieve aggregated summary information of Scheduler Jobs within a Compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobCounts", "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\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'." } ] }, "docs": "Retrieve aggregated summary information of Scheduler Jobs within a Compartment.\n" }, { "info": { "name": "Gets a list of all schedule jobs in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs", "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": "compartmentIdInSubtree", "value": "", "type": "query", "description": "If set to true, resources will be returned for not only the provided compartment, but all compartments which\ndescend from it. Which resources are returned and their field contents depends on the value of accessLevel.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState." }, { "name": "fleetId", "value": "", "type": "query", "description": "unique Fleet identifier" }, { "name": "timeScheduledGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "timeScheduledLessThan", "value": "", "type": "query", "description": "Scheduled Time" }, { "name": "isRemediationJobNeeded", "value": "", "type": "query", "description": "Fetch next remediation Job" }, { "name": "substate", "value": "", "type": "query", "description": "A filter to return only resources their subState matches the given subState." }, { "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 Schedule Job by id.\nEither compartmentId or id must be provided.\n" }, { "name": "schedulerDefintionId", "value": "", "type": "query", "description": "SchedulerDefinition 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 and timeScheduled is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all schedule jobs in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Get Schedule Job.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" } ] }, "docs": "Get the details of a lifecycle management operations job in Fleet Application Management." }, { "info": { "name": "Updates certain attributes for the specified schedule job.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain attributes for the specified schedule job." }, { "info": { "name": "Deletes the schedule job specified by an identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" } ] }, "docs": "Deletes the schedule job specified by an identifier." }, { "info": { "name": "Manage execution actions for a Job", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/actions/manageJobExecution", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Manage execution actions for a Job like retrying or pausing a task.\n" }, { "info": { "name": "Get JobActivity", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/jobActivities/:jobActivityId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" }, { "name": "jobActivityId", "value": "", "type": "path", "description": "unique jobActivity identifier" }, { "name": "isDetailsRequired", "value": "", "type": "query", "description": "If set to true, inventory details will be returned.\n" } ] }, "docs": "Gets activity details by identifier for a job." }, { "info": { "name": "List Resources for JobActivity", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/jobActivities/:jobActivityId/resources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" }, { "name": "jobActivityId", "value": "", "type": "path", "description": "unique jobActivity identifier" }, { "name": "resourceTaskId", "value": "", "type": "query", "description": "Task Id" }, { "name": "stepName", "value": "", "type": "query", "description": "Unique step name" }, { "name": "targetName", "value": "", "type": "query", "description": "Unique target name" }, { "name": "sequence", "value": "", "type": "query", "description": "Task Order Sequence" }, { "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 timeStarted is descending.\n" } ] }, "docs": "Returns a list of resources for an Activity Execution." }, { "info": { "name": "List Task Executions for a Resource", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/jobActivities/:jobActivityId/resources/:resourceId/executions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" }, { "name": "jobActivityId", "value": "", "type": "path", "description": "unique jobActivity identifier" }, { "name": "resourceId", "value": "", "type": "path", "description": "unique Resource identifier" }, { "name": "resourceTaskId", "value": "", "type": "query", "description": "Task Id" }, { "name": "stepName", "value": "", "type": "query", "description": "Unique step name" }, { "name": "targetName", "value": "", "type": "query", "description": "Unique target name" }, { "name": "sequence", "value": "", "type": "query", "description": "Task Order Sequence" }, { "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 timeStarted is descending.\n" } ] }, "docs": "Returns a list of Task Executions for a Resource." }, { "info": { "name": "Get Task Execution Details", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/jobActivities/:jobActivityId/resources/:resourceId/executions/:executionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" }, { "name": "jobActivityId", "value": "", "type": "path", "description": "unique jobActivity identifier" }, { "name": "resourceId", "value": "", "type": "path", "description": "unique Resource identifier" }, { "name": "executionId", "value": "", "type": "path", "description": "Execution Id" } ] }, "docs": "Get Task Execution by Identifier for a Resource within an action group." }, { "info": { "name": "List Steps for JobActivity", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/schedulerJobs/:schedulerJobId/jobActivities/:jobActivityId/steps", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "schedulerJobId", "value": "", "type": "path", "description": "unique SchedulerJob identifier" }, { "name": "jobActivityId", "value": "", "type": "path", "description": "unique jobActivity identifier" }, { "name": "resourceTaskId", "value": "", "type": "query", "description": "Task Id" }, { "name": "stepName", "value": "", "type": "query", "description": "Unique step name" }, { "name": "targetName", "value": "", "type": "query", "description": "Unique target name" }, { "name": "sequence", "value": "", "type": "query", "description": "Task Order Sequence" }, { "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 timeStarted is descending.\n" } ] }, "docs": "Returns a list of Steps for an Activity Execution." }, { "info": { "name": "Gets a list of target component.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/targetComponents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "targetId", "value": "", "type": "query", "description": "Target Id." }, { "name": "targetName", "value": "", "type": "query", "description": "Target name." }, { "name": "severity", "value": "", "type": "query", "description": "Patch severity." }, { "name": "name", "value": "", "type": "query", "description": "Target Component Name." }, { "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.\n" } ] }, "docs": "Gets a list of target component.\n" }, { "info": { "name": "Gets a list of target properties.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/targetProperties", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "targetId", "value": "", "type": "query", "description": "Target Id." }, { "name": "targetName", "value": "", "type": "query", "description": "Target name." }, { "name": "severity", "value": "", "type": "query", "description": "Patch severity." }, { "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.\n" } ] }, "docs": "Gets a list of target properties.\n" } ] } ], "bundled": true }