{ "opencollection": "1.0.0", "info": { "name": "Fleet Application Management Service Fleet Apps Management Admin API", "version": "20250228" }, "items": [ { "info": { "name": "fleetAppsManagementAdmin", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of compliancePolicies.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/compliancePolicies", "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 resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "type", "value": "", "type": "query", "description": "A filter to return Platform Configurations whose type matches the given type." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Compliance Policy 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 Compliance Policies in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Get CompliancePolicy", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/compliancePolicies/:compliancePolicyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compliancePolicyId", "value": "", "type": "path", "description": "unique CompliancePolicy identifier." } ] }, "docs": "Gets information about a compliance policy." }, { "info": { "name": "Gets a list of compliancePolicyRules.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/compliancePolicyRules", "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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, { "name": "patchName", "value": "", "type": "query", "description": "A filter to return only resources that match the patch selection against the given patch name." }, { "name": "compliancePolicyId", "value": "", "type": "query", "description": "unique CompliancePolicy identifier." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Compliance Policy Rule 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": "Gets a list of Compliance policy rules in a compartment.\n" }, { "info": { "name": "Creates a CompliancePolicyRule.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/compliancePolicyRules", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a compliance policy rule.\n" }, { "info": { "name": "Get CompliancePolicyRule", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/compliancePolicyRules/:compliancePolicyRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compliancePolicyRuleId", "value": "", "type": "path", "description": "unique CompliancePolicyRule identifier." } ] }, "docs": "Gets information about a compliance policy rule." }, { "info": { "name": "Updates a CompliancePolicy.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/compliancePolicyRules/:compliancePolicyRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compliancePolicyRuleId", "value": "", "type": "path", "description": "unique CompliancePolicyRule identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a compliance policy rule specified by an identifier." }, { "info": { "name": "Deletes a CompliancePolicyRule.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/compliancePolicyRules/:compliancePolicyRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compliancePolicyRuleId", "value": "", "type": "path", "description": "unique CompliancePolicyRule identifier." } ] }, "docs": "Deletes a compliance policy rule specified by an identifier." }, { "info": { "name": "Returns a list of onboarding policy information for Fleet Application Management", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/onboardingPolicies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "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.\n" } ] }, "docs": "Returns a list of onboarding policy information for Fleet Application Management.\n" }, { "info": { "name": "Returns a list of onboarding information for the Tenancy", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/onboardings", "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 resources whose lifecycleState matches the given lifecycleState." }, { "name": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single onboarding 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 onboardings in the specified root compartment (tenancy).\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Onboard a tenant to Fleet Application Management.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/onboardings", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Onboard a tenant to Fleet Application Management.\nThe onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features.\n" }, { "info": { "name": "Get Fleet Application Management OnboardingDetails", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/onboardings/:onboardingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A filter to return resources whose Onboarding identifier matches the given identifier." } ] }, "docs": "Gets a Fleet Application Management Onboarding by identifier." }, { "info": { "name": "Update the Onboarding identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/onboardings/:onboardingId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A filter to return resources whose Onboarding identifier matches the given identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Onboarding" }, { "info": { "name": "Delete Fleet Application Management onboarding for a Tenant", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/onboardings/:onboardingId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A filter to return resources whose Onboarding identifier matches the given identifier." } ] }, "docs": "Deletes Fleet Application Management onboarding resource by identifier" }, { "info": { "name": "Enable Policies for a newer version of Fleet Application Management", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/onboardings/:onboardingId/actions/enableLatestPolicy", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A filter to return resources whose Onboarding identifier matches the given identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Policies for a newer version of Fleet Application Management" }, { "info": { "name": "Manage the onboarding settings identified by the id", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/onboardings/:onboardingId/actions/manageSettings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "onboardingId", "value": "", "type": "path", "description": "A filter to return resources whose Onboarding identifier matches the given identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Onboarding setting" }, { "info": { "name": "Gets a list of all Platform Configurations in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/platformConfigurations", "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 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": "id", "value": "", "type": "query", "description": "Unique identifier or OCID for listing a single Platform Configuration by id.\nEither compartmentId or id must be provided.\n" }, { "name": "configCategory", "value": "", "type": "query", "description": "Config Category" }, { "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": "type", "value": "", "type": "query", "description": "A filter to return Platform Configurations whose type matches the given 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. Default order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of all the Platform Configurations in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new PlatformConfiguration", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/platformConfigurations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new PlatformConfiguration.\n" }, { "info": { "name": "Get PlatformConfiguration", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/platformConfigurations/:platformConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "platformConfigurationId", "value": "", "type": "path", "description": "unique PlatformConfiguration identifier" } ] }, "docs": "Gets a PlatformConfiguration by identifier" }, { "info": { "name": "Update the PlatformConfiguration identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/platformConfigurations/:platformConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "platformConfigurationId", "value": "", "type": "path", "description": "unique PlatformConfiguration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the PlatformConfiguration" }, { "info": { "name": "Delete a provisioned PlatformConfiguration", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/platformConfigurations/:platformConfigurationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "platformConfigurationId", "value": "", "type": "path", "description": "unique PlatformConfiguration identifier" } ] }, "docs": "Deletes a PlatformConfiguration resource by identifier" }, { "info": { "name": "Moves a PlatformConfiguration into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/platformConfigurations/:platformConfigurationId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "platformConfigurationId", "value": "", "type": "path", "description": "unique PlatformConfiguration identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a PlatformConfiguration 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 all Properties in a Tenancy", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/properties", "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 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": "Unique identifier or OCID for listing a single Property by id.\nEither compartmentId or id must be provided.\n \n" }, { "name": "type", "value": "", "type": "query", "description": "A filter to return properties whose type matches the given type." }, { "name": "scope", "value": "", "type": "query", "description": "A filter to return only resources their scope matches the given scope." }, { "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 Properties in the specified compartment.\nThe query parameter `compartmentId` is required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Creates a new Property", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/properties", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a business-specific metadata property in Fleet Application Management.\n" }, { "info": { "name": "Get Property", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250228/properties/:propertyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "propertyId", "value": "", "type": "path", "description": "unique Property identifier" } ] }, "docs": "Gets a Property by identifier" }, { "info": { "name": "Update the Property identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250228/properties/:propertyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "propertyId", "value": "", "type": "path", "description": "unique Property identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a property in Fleet Application Management." }, { "info": { "name": "Delete a provisioned Property", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250228/properties/:propertyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "propertyId", "value": "", "type": "path", "description": "unique Property identifier" } ] }, "docs": "Delete a property in Fleet Application Management." }, { "info": { "name": "Moves a Property into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250228/properties/:propertyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "propertyId", "value": "", "type": "path", "description": "unique Property identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Property 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" } ] } ], "bundled": true }