openapi: 3.2.0
info:
  description: "Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n"
  title: OS Management Hub Lifecycle Environment API
  version: '20220901'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml
    what: the harvested document for OS Management Hub API
servers:
- url: http://127.0.0.1/20220901
- url: https://127.0.0.1/20220901
tags:
- name: lifecycleEnvironment
paths:
  /lifecycleEnvironments:
    get:
      description: 'Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list

        against a variety of criteria including but not limited to its name, status, architecture, and OS family.

        '
      operationId: ListLifecycleEnvironments
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleEnvironmentIdentifierQueryParam'
      - $ref: '#/components/parameters/ArchTypeQueryParam'
      - $ref: '#/components/parameters/OsFamilyQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleEnvironmentLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/LifecycleEnvironmentSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of lifecycle environments was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleEnvironmentCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all lifecycle environments in a compartment
      tags:
      - lifecycleEnvironment
      x-example: 'GET 20220901/lifecycleEnvironments?compartmentId=<var>&lt;compartment_OCID&gt;</var>&limit=10

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/LifecycleEnvironment'
    post:
      description: 'Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.

        '
      operationId: CreateLifecycleEnvironment
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The lifecycle environment was created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleEnvironment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new lifecycle environment
      tags:
      - lifecycleEnvironment
      x-example: "POST 20220901/lifecycleEnvironments\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"My-New-Environment\",\n  \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n  ...\n}\n"
      x-related-resource: '#/definitions/LifecycleEnvironment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLifecycleEnvironmentDetails'
        description: Details for the new lifecycle environment.
        required: true
  /lifecycleEnvironments/{lifecycleEnvironmentId}:
    delete:
      description: 'Deletes the specified lifecycle environment.

        '
      operationId: DeleteLifecycleEnvironment
      parameters:
      - $ref: '#/components/parameters/LifecycleEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The lifecycle environment was deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a lifecycle environment
      tags:
      - lifecycleEnvironment
      x-example: 'DELETE 20220901/lifecycleEnvironments/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        If-Match: "<etag>"

        '
      x-related-resource: '#/definitions/LifecycleEnvironment'
    get:
      description: Gets information about the specified lifecycle environment.
      operationId: GetLifecycleEnvironment
      parameters:
      - $ref: '#/components/parameters/LifecycleEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The lifecycle environment was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleEnvironment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a lifecycle environment
      tags:
      - lifecycleEnvironment
      x-example: 'GET 20220901/lifecycleEnvironments/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: Updates the specified lifecycle environment's name, description, stages, or tags.
      operationId: UpdateLifecycleEnvironment
      parameters:
      - $ref: '#/components/parameters/LifecycleEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The lifecycle environment was updated.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleEnvironment'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a lifecycle environment
      tags:
      - lifecycleEnvironment
      x-example: "PUT 20220901/lifecycleEnvironments/<var>&lt;resource_OCID&gt;</var>\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nIf-Match: \"<etag>\"\n{\n  \"displayName\": \"Updated-Environment-Name\"\n}\n"
      x-related-resource: '#/definitions/LifecycleEnvironment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLifecycleEnvironmentDetails'
        description: The information to be updated.
        required: true
  /lifecycleEnvironments/{lifecycleEnvironmentId}/actions/changeCompartment:
    post:
      description: '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).

        '
      operationId: ChangeLifecycleEnvironmentCompartment
      parameters:
      - $ref: '#/components/parameters/LifecycleEnvironmentIdentifierPathParam'
      - $ref: '#/components/parameters/ChangeLifecycleEnvironmentCompartmentDetailsParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: 'The lifecycle environment was moved to a different compartment.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves a lifecycle environment into a different compartment.
      tags:
      - lifecycleEnvironment
      x-example: "POST 20220901/lifecycleEnvironments/<var>&lt;resource_OCID&gt;</var>/actions/changeCompartment\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nIf-Match: \"<etag>\"\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\"\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/LifecycleEnvironment'
  /lifecycleStages:
    get:
      description: 'Lists lifecycle stages that match the specified compartment or lifecycle stage [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against

        '
      operationId: ListLifecycleStages
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdentifierQueryParam'
      - $ref: '#/components/parameters/SoftwareSourceIdQueryParam'
      - $ref: '#/components/parameters/ArchTypeQueryParam'
      - $ref: '#/components/parameters/OsFamilyQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStageLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/LifecycleStageSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of lifecycle stages was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleStageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all lifecycle stages in a compartment.
      tags:
      - lifecycleEnvironment
      x-example: 'GET 20220901/lifecycleStages

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/LifecycleStage'
  /lifecycleStages/{lifecycleStageId}:
    get:
      description: 'Returns information about the specified lifecycle stage.

        '
      operationId: GetLifecycleStage
      parameters:
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The lifecycle stage was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleStage'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a lifecycle stage
      tags:
      - lifecycleEnvironment
      x-example: 'GET 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /lifecycleStages/{lifecycleStageId}/actions/attachManagedInstances:
    post:
      description: 'Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.

        '
      operationId: AttachManagedInstancesToLifecycleStage
      parameters:
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The managed instance was attached to the lifecycle stage.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Attach managed instances to lifecycle stage
      tags:
      - lifecycleEnvironment
      x-example: "POST 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>/actions/attachManagedInstances\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"managedInstanceIds\": [\"ocid1.instance.oc1..&lt;unique_id&gt;\"]\n}\n"
      x-related-resource: '#/definitions/LifecycleStage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachManagedInstancesToLifecycleStageDetails'
        description: Details for managed instances to attach to the lifecycle stage.
        required: true
  /lifecycleStages/{lifecycleStageId}/actions/detachManagedInstances:
    post:
      description: 'Detaches (removes) a managed instance from a lifecycle stage.

        '
      operationId: DetachManagedInstancesFromLifecycleStage
      parameters:
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The managed instance was detached from the lifecycle stage.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Detach a managed instance from a lifecycle stage.
      tags:
      - lifecycleEnvironment
      x-example: "POST 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>/actions/detachManagedInstances\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"managedInstanceIds\": [\"ocid1.instance.oc1..&lt;unique_id&gt;\"]\n}\n"
      x-related-resource: '#/definitions/LifecycleStage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetachManagedInstancesFromLifecycleStageDetails'
        description: Details for the managed instance to detach from the lifecycle stage.
        required: true
  /lifecycleStages/{lifecycleStageId}/actions/promoteSoftwareSource:
    post:
      description: 'Updates the versioned custom software source content to the specified lifecycle stage.

        A 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.

        The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don''t provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.

        '
      operationId: PromoteSoftwareSourceToLifecycleStage
      parameters:
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/SoftwareSourceIdQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The software source was promoted to the lifecycle stage.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Promote versioned software source to lifecycle stage
      tags:
      - lifecycleEnvironment
      x-example: "POST 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>/actions/promoteSoftwareSource\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"softwareSourceId\": \"ocid1.softwaresource.oc1..&lt;unique_id&gt;\"\n}\n"
      x-related-resource: '#/definitions/LifecycleStage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoteSoftwareSourceToLifecycleStageDetails'
        description: Details for the software source promotion job.
        required: true
  /lifecycleStages/{lifecycleStageId}/actions/reboot:
    post:
      description: 'Reboots all managed instances in the specified lifecycle stage.

        '
      operationId: RebootLifecycleStage
      parameters:
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: 'The managed instances in a lifecycle stage will be rebooted

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Reboots managed instances in a lifecycle stage.
      tags:
      - lifecycleEnvironment
      x-example: 'POST 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>/actions/reboot

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/LifecycleStage'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RebootLifecycleStageDetails'
        description: Details rebooting managed instances in a lifecycle stage.
        required: true
  /lifecycleStages/{lifecycleStageId}/installedPackages:
    get:
      description: "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"
      operationId: ListLifecycleStageInstalledPackages
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/MultiDisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/LifecycleStageIdentifierPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/LifecycleStageLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/LifecycleStageSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A list of installed packages was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstalledPackageCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists packages installed on the managed instances in a lifecycle stage
      tags:
      - lifecycleEnvironment
      x-example: 'GET 20220901/lifecycleStages/<var>&lt;resource_OCID&gt;</var>/installedPackages

        Host: osmh.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/LifecycleStage'
components:
  parameters:
    LifecycleEnvironmentLifecycleStateQueryParam:
      description: A filter to return only the lifecycle environments that match the display name given.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/LifecycleEnvironment/lifecycleState'
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `3`

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    ChangeLifecycleEnvironmentCompartmentDetailsParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the lifecycle environment into.
      in: body
      name: ChangeLifecycleEnvironmentCompartmentDetails
      required: true
      schema:
        $ref: '#/components/schemas/ChangeLifecycleEnvironmentCompartmentDetails'
    OsFamilyQueryParam:
      description: A filter to return only resources that match the given operating system family.
      in: query
      name: osFamily
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OsFamily'
      schema:
        type: string
        enum:
        - ORACLE_LINUX_10
        - ORACLE_LINUX_9
        - ORACLE_LINUX_8
        - ORACLE_LINUX_7
        - ORACLE_LINUX_6
        - WINDOWS_SERVER_2016
        - WINDOWS_SERVER_2019
        - WINDOWS_SERVER_2022
        - WINDOWS_SERVER_2025
        - WINDOWS_11
        - ALL
        - UBUNTU_20_04
        - UBUNTU_22_04
        - UBUNTU_24_04
    MultiDisplayNameQueryParam:
      description: A filter to return resources that match the given display names.
      in: query
      name: displayName
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          maxLength: 255
          minLength: 1
          type: string
        maxItems: 5
        uniqueItems: true
    DisplayNameContainsQueryParam:
      description: A filter to return resources that may partially match the given display name.
      in: query
      name: displayNameContains
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    CompartmentIdQueryParam:
      description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    LifecycleStageIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage.
      in: query
      name: lifecycleStageId
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    MultiLocationQueryParam:
      description: A filter to return only resources whose location matches the given value.
      in: query
      name: location
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    LifecycleEnvironmentSortByQueryParam:
      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.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    SoftwareSourceIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source.
      in: query
      name: softwareSourceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

        For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


        Example: `50`

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 100
        minimum: 1
    LifecycleStageLifecycleStateQueryParam:
      description: A filter to return only lifecycle stages whose lifecycle state matches the given lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/LifecycleStage/lifecycleState'
      schema:
        type: string
    LifecycleEnvironmentIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment.
      in: query
      name: lifecycleEnvironmentId
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or 'DESC'.
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    MultiLocationNotEqualToQueryParam:
      description: A filter to return only resources whose location does not match the given value.
      in: query
      name: locationNotEqualTo
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        maxItems: 5
        uniqueItems: true
    LifecycleStageIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage.
      in: path
      name: lifecycleStageId
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    LifecycleStageSortByQueryParam:
      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.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ArchTypeQueryParam:
      description: A filter to return only profiles that match the given archType.
      in: query
      name: archType
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/ArchType'
      schema:
        type: string
        enum:
        - X86_64
        - AARCH64
        - I686
        - NOARCH
        - SRC
        - I386
        - AMD64
        - ARM64
        - ALL
    RequestIdHeader:
      description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
      in: header
      name: opc-request-id
      schema:
        type: string
    LifecycleEnvironmentIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment.
      in: path
      name: lifecycleEnvironmentId
      required: true
      schema:
        type: string
  schemas:
    ManagedInstanceDetails:
      description: Provides identifying information for the specified managed instance.
      properties:
        displayName:
          description: Managed instance name.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance.
          type: string
      required:
      - id
      type: object
    Error:
      description: Provides the information for an error.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    InstalledPackageCollection:
      description: The set of installed packages on a managed instance.
      properties:
        items:
          description: List of installed packages.
          items:
            $ref: '#/components/schemas/InstalledPackageSummary'
          type: array
      required:
      - items
      type: object
    PackageSummary:
      description: Provides summary information for a software package.
      discriminator:
        propertyName: packageClassification
      properties:
        architecture:
          description: The architecture for which this package was built.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        displayName:
          description: Package name.
          type: string
        name:
          description: Unique identifier for the package.
          type: string
        packageClassification:
          description: Status of the software package.
          enum:
          - INSTALLED
          - AVAILABLE
          - UPDATABLE
          type: string
        softwareSources:
          description: List of software sources that provide the software package.
          items:
            $ref: '#/components/schemas/SoftwareSourceDetails'
          type: array
        type:
          description: Type of the package.
          type: string
        version:
          description: Version of the installed package.
          type: string
      required:
      - displayName
      - type
      - version
      - name
      - packageClassification
    LifecycleEnvironment:
      description: 'Defines the lifecycle environment, including the associated versioned software sources, lifecycle stages, and managed instances.

        '
      properties:
        archType:
          description: The CPU architecture of the managed instances in the lifecycle environment.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle environment.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified information about the lifecycle environment.
          type: string
        displayName:
          description: The user-friendly name for the lifecycle environment.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment.
          type: string
        lifecycleState:
          description: The current state of the lifecycle environment.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        location:
          description: The location of managed instances attached to the lifecycle environment.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        managedInstanceIds:
          description: List of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) assigned to the lifecycle stage.
          items:
            $ref: '#/components/schemas/ManagedInstanceDetails'
          type: array
        osFamily:
          description: The operating system of the managed instances in the lifecycle environment.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        stages:
          description: User-specified list of lifecycle stages used within the lifecycle environment.
          items:
            $ref: '#/components/schemas/LifecycleStage'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeModified:
          description: The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        vendorName:
          description: The vendor of the operating system used by the managed instances in the lifecycle environment.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
      required:
      - id
      - compartmentId
      - displayName
      - stages
      - timeCreated
      - osFamily
      - archType
      - vendorName
      - lifecycleState
      type: object
      x-example: "{\n  \"id\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n  \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n  \"displayName\": \"My-Display-Name\",\n  \"description\": \"User-specified information about the lifecycle environment.\",\n  \"stages\": [\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Stage-1\",\n      \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"rank\": 1,\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"managedInstanceIds\": [\n        \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n      ],\n      \"location\": \"OCI_COMPUTE\",\n      \"softwareSourceId\": null,\n      \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Stage-2\",\n      \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"rank\": 2,\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"managedInstanceIds\": [\n        \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n      ],\n      \"location\": \"OCI_COMPUTE\",\n      \"softwareSourceId\": null,\n      \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    }\n  ],\n  \"managedInstanceIds\": null,\n  \"lifecycleState\": \"ACTIVE\",\n  \"osFamily\": \"ORACLE_LINUX_8\",\n  \"archType\": \"X86_64\",\n  \"vendorName\": \"ORACLE\",\n  \"location\": \"OCI_COMPUTE\",\n  \"timeCreated\": \"2025-02-06T16:04:40.075Z\",\n  \"timeModified\": \"2025-02-06T16:04:40.075Z\",\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n"
    LifecycleStageCollection:
      description: 'A set of lifecycle stages returned for the [ListLifecycleStages](#/en/osmh/latest/LifecycleStage/ListLifecycleStages) operation.

        '
      properties:
        items:
          description: List of lifecycle stages.
          items:
            $ref: '#/components/schemas/LifecycleStageSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Stage-1\",\n      \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"rank\": 1,\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"location\": \"OCI_COMPUTE\",\n      \"managedInstanceIds\": [\n        \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n      ],\n      \"location\": \"OCI_COMPUTE\",\n      \"softwareSourceId\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n      \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Stage-2\",\n      \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"rank\": 2,\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"location\": \"OCI_COMPUTE\",\n      \"managedInstanceIds\": [\n        \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n      ],\n      \"location\": \"OCI_COMPUTE\",\n      \"softwareSourceId\": null,\n      \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    }\n  ]\n}\n"
    ChangeLifecycleEnvironmentCompartmentDetails:
      description: Provides the information used to move the lifecycle environment to another compartment.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the lifecycle environment to.

            '
          maxLength: 255
          minLength: 1
          type: string
    UpdateLifecycleStageDetails:
      description: Provides the information used to update the lifecycle stage.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: A user-friendly name for the lifecycle stage. Does not have to be unique. Avoid entering confidential information.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage.
          type: string
      required:
      - id
      type: object
    RebootLifecycleStageDetails:
      description: Provides the information used for the reboot job.
      properties:
        rebootTimeoutInMins:
          default: 20
          description: "The number of minutes the service waits for the reboot to complete. If the instances in the stage don't reboot \nwithin this time, the reboot job status is set to failed.\n"
          maximum: 240
          minimum: 5
          type: integer
        workRequestDetails:
          $ref: '#/components/schemas/WorkRequestDetails'
      type: object
    InstalledPackageSummary:
      allOf:
      - $ref: '#/components/schemas/PackageSummary'
      - discriminator:
          propertyName: INSTALLED
        properties:
          timeInstalled:
            description: 'The date and time the package was installed, as described in

              [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

              '
            format: date-time
            type: string
          timeIssued:
            description: 'The date and time the package was issued by a providing erratum (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

              '
            format: date-time
            type: string
        required:
        - timeInstalled
      description: Provides summary information for a software package installed on a managed instance.
    LifecycleStageSummary:
      description: Provides summary information for a lifecycle stage.
      properties:
        archType:
          description: The CPU architecture of the managed instances in the lifecycle stage.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle stage.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: The user-friendly name for the lifecycle stage.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage.
          type: string
        lifecycleEnvironmentDisplayName:
          description: The user-friendly name for the lifecycle environment. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          type: string
        lifecycleEnvironmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment that contains the lifecycle stage.
          type: string
        lifecycleState:
          description: The current state of the lifecycle environment.
          type: string
          x-obmcs-enumref: '#/definitions/LifecycleStage/lifecycleState'
        location:
          description: The location of managed instances associated with the lifecycle stage.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        managedInstances:
          description: The list of managed instances associated with the lifecycle stage.
          type: integer
        osFamily:
          description: The operating system of the managed instances in the lifecycle stage.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        rank:
          description: 'User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment.

            '
          type: integer
        softwareSourceId:
          $ref: '#/components/schemas/SoftwareSourceDetails'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the lifecycle stage was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeModified:
          description: The time the lifecycle stage was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        vendorName:
          description: The vendor of the operating system used by the managed instances in the lifecycle stage.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
      required:
      - compartmentId
      - displayName
      - rank
      type: object
    LifecycleStage:
      description: Defines the lifecycle stage.
      properties:
        archType:
          description: The CPU architecture of the managed instances in the lifecycle stage.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle stage.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: The user-friendly name for the lifecycle stage.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle stage.
          type: string
        lifecycleEnvironmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment that contains the lifecycle stage.
          type: string
        lifecycleState:
          description: The current state of the lifecycle stage.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        location:
          description: The location of managed instances associated with the lifecycle stage.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        managedInstanceIds:
          description: The list of managed instances associated with the lifecycle stage.
          items:
            $ref: '#/components/schemas/ManagedInstanceDetails'
          type: array
        osFamily:
          description: The operating system of the managed instances in the lifecycle stage.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        rank:
          default: 1
          description: 'User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment.

            '
          maximum: 5
          minimum: 1
          type: integer
        softwareSourceId:
          $ref: '#/components/schemas/SoftwareSourceDetails'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the lifecycle stage was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeModified:
          description: The time the lifecycle stage was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        vendorName:
          description: The vendor of the operating system used by the managed instances in the lifecycle stage.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
      required:
      - compartmentId
      - displayName
      - rank
      type: object
      x-example: "{\n \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n \"displayName\": \"My-Stage-1\",\n \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n \"rank\": 1,\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"managedInstanceIds\": [\n   \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n ],\n \"location\": \"OCI_COMPUTE\",\n \"softwareSourceId\": \"ocid1.osmhsoftwaresource.oc1..&lt;unique_id&gt;\",\n \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"freeformTags\": {},\n \"definedTags\": {},\n \"systemTags\": {}\n}\n"
    CreateLifecycleEnvironmentDetails:
      description: 'Provides the information used to create a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.

        '
      properties:
        archType:
          description: The CPU architecture of the managed instances in the lifecycle environment.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle environment.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified information about the lifecycle environment. Avoid entering confidential information.
          maxLength: 400
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name for the lifecycle environment. Does not have to be unique and you can change the name later. Avoid entering confidential information.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        location:
          description: 'The location of managed instances attached to the lifecycle environment. If no location is provided, the default is ''ON_PREMISE.''

            '
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        osFamily:
          description: The operating system of the managed instances in the lifecycle environment.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        stages:
          description: User-specified list of ranked lifecycle stages used within the lifecycle environment.
          items:
            $ref: '#/components/schemas/CreateLifecycleStageDetails'
          maxItems: 5
          type: array
        vendorName:
          description: The vendor of the operating system used by the managed instances in the lifecycle environment.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
      required:
      - compartmentId
      - displayName
      - archType
      - osFamily
      - vendorName
      - stages
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n  \"displayName\": \"My-Display-Name\",\n  \"description\": \"User-specified information about the lifecycle environment.\",\n  \"stages\": [\n    {\n      \"displayName\": \"My-Stage-1\",\n      \"rank\": 1\n    },\n    {\n      \"displayName\": \"My-Stage-2\",\n      \"rank\": 2\n    }\n  ],\n  \"osFamily\": \"ORACLE_LINUX_8\",\n  \"archType\": \"X86_64\",\n  \"vendorName\": \"ORACLE\",\n  \"location\": \"OCI_COMPUTE\"\n  \"freeformTags\": {},\n  \"definedTags\": {}\n}\n"
    SoftwareSourceDetails:
      description: Provides identifying information for the specified software source.
      properties:
        description:
          description: Software source description.
          type: string
        displayName:
          description: Software source name.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
          type: string
        isMandatoryForAutonomousLinux:
          description: Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it.
          type: boolean
        softwareSourceType:
          description: Type of the software source.
          enum:
          - VENDOR
          - CUSTOM
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType'
      required:
      - id
      type: object
    AttachManagedInstancesToLifecycleStageDetails:
      description: The managed instances to attach to the lifecycle stage.
      properties:
        managedInstanceDetails:
          $ref: '#/components/schemas/ManagedInstancesDetails'
      required:
      - managedInstanceDetails
    DetachManagedInstancesFromLifecycleStageDetails:
      description: The managed instances to detach from the lifecycle stage.
      properties:
        managedInstanceDetails:
          $ref: '#/components/schemas/ManagedInstancesDetails'
      required:
      - managedInstanceDetails
    PromoteSoftwareSourceToLifecycleStageDetails:
      description: 'Provides detailed information about the lifecycle stage promotion.

        '
      properties:
        workRequestDetails:
          $ref: '#/components/schemas/WorkRequestDetails'
      type: object
    LifecycleEnvironmentCollection:
      description: A set of lifecycle environments returned for the [ListLifecycleEnvironments](#/en/osmh/latest/LifecycleEnvironment/ListLifecycleEnvironments) operation. The list contains a summary of each lifecycle environment and other information, such as metadata.
      properties:
        items:
          description: List of lifecycle environments.
          items:
            $ref: '#/components/schemas/LifecycleEnvironmentSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Lifecycle-Environment-1\",\n      \"description\": \"User-specified information about the lifecycle environment.\",\n      \"stages\": [\n        {\n          \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n          \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n          \"displayName\": \"My-Stage-1\",\n          \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n          \"rank\": 1,\n          \"osFamily\": \"ORACLE_LINUX_8\",\n          \"archType\": \"X86_64\",\n          \"vendorName\": \"ORACLE\",\n          \"managedInstanceIds\": [\n            \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n          ],\n          \"location\": \"OCI_COMPUTE\",\n          \"softwareSourceId\": null,\n          \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n          \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n          \"lifecycleState\": \"ACTIVE\",\n          \"freeformTags\": {},\n          \"definedTags\": {},\n          \"systemTags\": {}\n        },\n        {\n          \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n          \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n          \"displayName\": \"My-Stage-2\",\n          \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n          \"rank\": 2,\n          \"osFamily\": \"ORACLE_LINUX_8\",\n          \"archType\": \"X86_64\",\n          \"vendorName\": \"ORACLE\",\n          \"managedInstanceIds\": [\n            \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n          ],\n          \"location\": \"OCI_COMPUTE\",\n          \"softwareSourceId\": null,\n          \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n          \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n          \"lifecycleState\": \"ACTIVE\",\n          \"freeformTags\": {},\n          \"definedTags\": {},\n          \"systemTags\": {}\n        }\n      ],\n      \"managedInstanceIds\": null,\n      \"lifecycleState\": \"ACTIVE\",\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"location\": \"OCI_COMPUTE\",\n      \"timeCreated\": \"2025-02-06T16:04:40.075Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.075Z\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n      \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Lifecycle-Environment-2\",\n      \"description\": \"User-specified information about the lifecycle environment.\",\n      \"stages\": [\n        {\n          \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n          \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n          \"displayName\": \"My-Stage-3\",\n          \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n          \"rank\": 1,\n          \"osFamily\": \"ORACLE_LINUX_8\",\n          \"archType\": \"X86_64\",\n          \"vendorName\": \"ORACLE\",\n          \"managedInstanceIds\": [\n            \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n          ],\n          \"location\": \"OCI_COMPUTE\",\n          \"softwareSourceId\": null,\n          \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n          \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n          \"lifecycleState\": \"ACTIVE\",\n          \"freeformTags\": {},\n          \"definedTags\": {},\n          \"systemTags\": {}\n        },\n        {\n          \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n          \"compartmentId\": \"ocid1.compartment.oc1..&lt;unique_id&gt;\",\n          \"displayName\": \"My-Stage-4\",\n          \"lifecycleEnvironmentId\": \"ocid1.osmhlifecycleenvironment.oc1..&lt;unique_id&gt;\",\n          \"rank\": 2,\n          \"osFamily\": \"ORACLE_LINUX_8\",\n          \"archType\": \"X86_64\",\n          \"vendorName\": \"ORACLE\",\n          \"managedInstanceIds\": [\n            \"ocid1.instance.oc1..&lt;unique_id&gt;\"\n          ],\n          \"location\": \"OCI_COMPUTE\",\n          \"softwareSourceId\": null,\n          \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n          \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n          \"lifecycleState\": \"ACTIVE\",\n          \"freeformTags\": {},\n          \"definedTags\": {},\n          \"systemTags\": {}\n        }\n      ],\n      \"managedInstanceIds\": null,\n      \"lifecycleState\": \"ACTIVE\",\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"vendorName\": \"ORACLE\",\n      \"location\": \"OCI_COMPUTE\",\n      \"timeCreated\": \"2025-02-06T16:04:40.075Z\",\n      \"timeModified\": \"2025-02-06T16:04:40.075Z\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    }\n  ]\n}\n"
    LifecycleEnvironmentSummary:
      description: Summary of the lifecycle environment.
      properties:
        archType:
          description: The CPU architecture of the managed instances in the lifecycle environment.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the lifecycle environment.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified information about the lifecycle environment.
          type: string
        displayName:
          description: A user-friendly name for the lifecycle environment.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the lifecycle environment.
          type: string
        lifecycleState:
          description: The current state of the lifecycle environment.
          type: string
          x-obmcs-enumref: '#/definitions/LifecycleEnvironment/lifecycleState'
        location:
          description: The location of managed instances attached to the lifecycle environment.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        osFamily:
          description: The operating system of the managed instances in the lifecycle environment.
          enum:
          - ORACLE_LINUX_10
          - ORACLE_LINUX_9
          - ORACLE_LINUX_8
          - ORACLE_LINUX_7
          - ORACLE_LINUX_6
          - WINDOWS_SERVER_2016
          - WINDOWS_SERVER_2019
          - WINDOWS_SERVER_2022
          - WINDOWS_SERVER_2025
          - WINDOWS_11
          - ALL
          - UBUNTU_20_04
          - UBUNTU_22_04
          - UBUNTU_24_04
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        stages:
          description: User-specified list of lifecycle stages used within the lifecycle environment.
          items:
            $ref: '#/components/schemas/LifecycleStageSummary'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the lifecycle environment was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        timeModified:
          description: The time the lifecycle environment was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
        vendorName:
          description: The vendor of the operating system used by the managed instances in the lifecycle environment.
          enum:
          - ORACLE
          - MICROSOFT
          - CANONICAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/VendorName'
      required:
      - id
      - compartmentId
      - description
      - displayName
      - archType
      - osFamily
      - vendorName
      - stages
      type: object
    CreateLifecycleStageDetails:
      description: Provides the information used to create a lifecycle stage.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: A user-friendly name for the lifecycle stage. Does not have to be unique and you can change the name later. Avoid entering confidential information.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        rank:
          default: 1
          description: 'User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment.

            '
          maximum: 5
          minimum: 1
          type: integer
      required:
      - displayName
      - rank
      type: object
    ManagedInstancesDetails:
      description: The details about the managed instances.
      properties:
        managedInstances:
          description: The list of managed instance OCIDs to be attached/detached.
          items:
            type: string
          type: array
        workRequestDetails:
          $ref: '#/components/schemas/WorkRequestDetails'
      required:
      - managedInstances
      type: object
    WorkRequestDetails:
      description: Provides the name and description of the job.
      properties:
        description:
          description: User-specified information about the job. Avoid entering confidential information.
          maxLength: 400
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    UpdateLifecycleEnvironmentDetails:
      description: Provides the information used to update the lifecycle environment.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        description:
          description: User-specified list of lifecycle stages used within the lifecycle environment. Avoid entering confidential information.
          maxLength: 400
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name for the lifecycle environment. Does not have to be unique. Avoid entering confidential information.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        stages:
          description: The list of lifecycle stages to be updated.
          items:
            $ref: '#/components/schemas/UpdateLifecycleStageDetails'
          maxItems: 5
          type: array
      type: object
      x-example: "{\n  \"displayName\": \"My-Updated-Display-Name\",\n  \"description\": \"User-specified updated information about the lifecycle environment\",\n  \"stages\": [\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Updated-Stage-1\"\n    },\n    {\n      \"id\": \"ocid1.osmhlifecyclestage.oc1..&lt;unique_id&gt;\",\n      \"displayName\": \"My-Updated-Stage-2\"\n    }\n  ]\n}\n"
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-total-items:
      description: 'The total number of items in the result. Used for pagination of a list of items.

        '
      type: integer
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{"Department": "Finance"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string type is supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.oci.osmh.api