{ "opencollection": "1.0.0", "info": { "name": "OS Management Hub Lifecycle Environment API", "version": "20220901" }, "items": [ { "info": { "name": "lifecycleEnvironment", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all lifecycle environments in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/lifecycleEnvironments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "lifecycleEnvironmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment." }, { "name": "archType", "value": "", "type": "query", "description": "A filter to return only profiles that match the given archType." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "location", "value": "", "type": "query", "description": "A filter to return only resources whose location matches the given value." }, { "name": "locationNotEqualTo", "value": "", "type": "query", "description": "A filter to return only resources whose location does not match the given value." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only the lifecycle environments that match the display name given." }, { "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.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list\nagainst a variety of criteria including but not limited to its name, status, architecture, and OS family.\n" }, { "info": { "name": "Creates a new lifecycle environment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleEnvironments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.\n" }, { "info": { "name": "Get a lifecycle environment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/lifecycleEnvironments/:lifecycleEnvironmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment." } ] }, "docs": "Gets information about the specified lifecycle environment." }, { "info": { "name": "Update a lifecycle environment", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220901/lifecycleEnvironments/:lifecycleEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified lifecycle environment's name, description, stages, or tags." }, { "info": { "name": "Delete a lifecycle environment", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220901/lifecycleEnvironments/:lifecycleEnvironmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment." } ] }, "docs": "Deletes the specified lifecycle environment.\n" }, { "info": { "name": "Moves a lifecycle environment into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleEnvironments/:lifecycleEnvironmentId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "lifecycleEnvironmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment." } ] }, "docs": "Moves a lifecycle environment into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a list of all lifecycle stages in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/lifecycleStages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "lifecycleStageId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." }, { "name": "softwareSourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source." }, { "name": "archType", "value": "", "type": "query", "description": "A filter to return only profiles that match the given archType." }, { "name": "osFamily", "value": "", "type": "query", "description": "A filter to return only resources that match the given operating system family." }, { "name": "location", "value": "", "type": "query", "description": "A filter to return only resources whose location matches the given value." }, { "name": "locationNotEqualTo", "value": "", "type": "query", "description": "A filter to return only resources whose location does not match the given value." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only lifecycle stages whose lifecycle state matches the given lifecycle state." }, { "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.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Lists lifecycle stages that match the specified compartment or lifecycle stage [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against\n" }, { "info": { "name": "Get a lifecycle stage", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." } ] }, "docs": "Returns information about the specified lifecycle stage.\n" }, { "info": { "name": "Attach managed instances to lifecycle stage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId/actions/attachManagedInstances", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.\n" }, { "info": { "name": "Detach a managed instance from a lifecycle stage.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId/actions/detachManagedInstances", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detaches (removes) a managed instance from a lifecycle stage.\n" }, { "info": { "name": "Promote versioned software source to lifecycle stage", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId/actions/promoteSoftwareSource", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." }, { "name": "softwareSourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the versioned custom software source content to the specified lifecycle stage.\nA versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error.\nThe softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it" }, { "info": { "name": "Reboots managed instances in a lifecycle stage.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId/actions/reboot", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reboots all managed instances in the specified lifecycle stage.\n" }, { "info": { "name": "Lists packages installed on the managed instances in a lifecycle stage", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220901/lifecycleStages/:lifecycleStageId/installedPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return resources that match the given display names." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "A filter to return resources that may partially match the given display name." }, { "name": "lifecycleStageId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `3`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only lifecycle stages whose lifecycle state matches the given lifecycle state." }, { "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.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety \nof criteria including but not limited to the package name.\n" } ] } ], "bundled": true }