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 Management Station 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: managementStation
paths:
  /managementStations:
    get:
      description: "Lists management stations within the specified compartment. Filter the list against a variety of criteria \nincluding but not limited to name, status, and location.\n"
      operationId: ListManagementStations
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/ManagementStationLifecycleStateQueryParam'
      - $ref: '#/components/parameters/ManagedInstanceIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/MultiLocationQueryParam'
      - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ManagementStationSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/ManagementStationIdQueryParam'
      - $ref: '#/components/parameters/HealthStateQueryParam'
      responses:
        200:
          description: The list of management stations 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/ManagementStationCollection'
        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 ManagementStations in a compartment
      tags:
      - managementStation
      x-example: 'GET 20220901/managementStations?compartmentId=<var>&lt;compartment_OCID&gt;</var>&limit=10

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

        <authorization and other headers>

        '
      x-related-resource: '#/definitions/ManagementStation'
    post:
      description: 'Creates a management station using the proxy and mirror configuration information provided.

        '
      operationId: CreateManagementStation
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The management station was successfully 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/ManagementStation'
        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 management station
      tags:
      - managementStation
      x-example: "POST 20220901/managementStations\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n  \"displayName\": \"example-name\",\n  \"hostname\": \"example-hostname\",\n  \"proxy\": {\n    \"isEnabled\": false\n  },\n  \"mirror\": {\n    \"directory\": \"/example/path\",\n    \"port\": \"1024\",\n    \"sslport\": \"1025\"\n  }\n}\n"
      x-related-resource: '#/definitions/ManagementStation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateManagementStationDetails'
        description: Provides the information used to create a management station.
        required: true
  /managementStations/{managementStationId}:
    delete:
      description: "Deletes a management station. You can't delete a station if there are resources associated with the station \n(such as instances using the station or profiles associated with the station). Switch stations and edit profiles\nas needed before deleting the station.\n"
      operationId: DeleteManagementStation
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The management station 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'
        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: Delete a Management Station
      tags:
      - managementStation
      x-example: 'DELETE 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>

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

        <authorization and other headers>

        '
      x-related-resource: '#/definitions/ManagementStation'
    get:
      description: 'Returns information about the specified management station.

        '
      operationId: GetManagementStation
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The management station 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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagementStation'
        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 ManagementStation
      tags:
      - managementStation
      x-example: 'GET 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>

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

        <authorization and other headers>

        '
    put:
      description: 'Updates the configuration of the specified management station.

        '
      operationId: UpdateManagementStation
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The management station 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/ManagementStation'
        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 the Management Station identified by the id
      tags:
      - managementStation
      x-example: "PUT 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n  \"displayName\": \"example-name\",\n  \"hostname\": \"example-hostname\"\n}\n"
      x-related-resource: '#/definitions/ManagementStation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateManagementStationDetails'
        description: The information used to update the management station.
        required: true
  /managementStations/{managementStationId}/actions/changeCompartment:
    post:
      description: Moves a managment station to a different compartment.
      operationId: ChangeManagementStationCompartment
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/ChangeManagementStationCompartmentDetailsParam'
      responses:
        204:
          description: The management station was moved to the specified 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 resource into a different compartment.
      tags:
      - managementStation
      x-example: "POST 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>/actions/changeCompartment\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\"\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/ManagementStation'
  /managementStations/{managementStationId}/actions/refresh:
    post:
      description: 'Refreshes the list of software sources mirrored by the management station.

        '
      operationId: RefreshManagementStationConfig
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: A work request was created to send the new configuration to the management station.
          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: Refresh config of Management Station
      tags:
      - managementStation
      x-example: 'POST 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>/actions/refresh

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

        <authorization and other headers>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/ManagementStation'
  /managementStations/{managementStationId}/actions/synchronizeMirrors:
    post:
      description: 'Synchronize the specified software sources mirrored on the management station.

        '
      operationId: SynchronizeMirrors
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: A work request was created to sync the specified mirrors associated with the management station.
          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: Synchronize the specified mirrors associated with the management station
      tags:
      - managementStation
      x-example: "POST 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>/actions/synchronizeMirrors\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n  \"softwareSourceList\": [\n    \"ocid1.osmhsoftwaresource.oc1.phx.exampleuniqueID\"\n  ]\n}\n"
      x-related-resource: '#/definitions/ManagementStation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynchronizeMirrorsDetails'
        description: Details for syncing mirrors
        required: true
  /managementStations/{managementStationId}/mirrors:
    get:
      description: 'Lists all software source mirrors associated with a specified management station.

        '
      operationId: ListMirrors
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/DisplayNameContainsQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/ManagementStationSortByQueryParam'
      - $ref: '#/components/parameters/MirrorStatesQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of software source mirrors 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/MirrorsCollection'
        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 Mirrors associated with the corresponding ManagementStation ID
      tags:
      - managementStation
      x-example: 'GET 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>/mirrors

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

        <authorization and other headers>

        '
      x-related-resource: '#/definitions/MirrorsCollection'
  /managementStations/{managementStationId}/mirrors/{mirrorId}/actions/synchronize:
    post:
      description: 'Synchronize the specified software source mirrors on the management station.

        '
      operationId: SynchronizeSingleMirrors
      parameters:
      - $ref: '#/components/parameters/ManagementStationIdPathParam'
      - $ref: '#/components/parameters/MirrorIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: A work request was created to synchronize the specified software source.
          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: Synchronize a single mirror
      tags:
      - managementStation
      x-example: 'POST 20220901/managementStations/<var>&lt;resource_OCID&gt;</var>/mirrors/<var>&lt;resource_OCID&gt;</var>/actions/synchronize

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

        <authorization and other headers>

        '
      x-related-resource: '#/definitions/ManagementStation'
components:
  schemas:
    ChangeManagementStationCompartmentDetails:
      description: Provides the information used to move a management station to a different compartment.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the management station to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    UpdateMirrorConfigurationDetails:
      allOf:
      - $ref: '#/components/schemas/CreateMirrorConfigurationDetails'
      description: Provides the information used to update the mirror configuration for a management station.
    MirrorsCollection:
      description: "The set of software source mirrors returned for the \n[ListMirrors](#/en/osmh/latest/MirrorsCollection/ListMirrors) operation.\n"
      properties:
        items:
          description: List of mirrors
          items:
            $ref: '#/components/schemas/MirrorSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"archType\": \"X86_64\",\n      \"displayName\": \"ol9_x86_64_userspace_ksplice\",\n      \"id\": \"ocid1.osmhsoftwaresource.oc1.phx.exampleuniqueID\",\n      \"log\": \"\\n [SKIPPED] openssl-perl-3.2.2-6.0.1.ksplice1.el9_5.x86_64.rpm: Already downloaded\\n [SKIPPED] openssl-perl-3.2.2-6.0.1.ksplice2.el9_5.x86_64.rpm: Already downloaded\",\n      \"osFamily\": \"ORACLE_LINUX_9\",\n      \"packageCount\": 941,\n      \"percentage\": 100,\n      \"size\": 18357329472,\n      \"state\": \"SYNCED\",\n      \"timeLastSynced\": \"2024-12-15T00:18:01.000Z\",\n      \"type\": \"VENDOR\"\n    }\n  ]\n}\n"
    ProxyConfiguration:
      description: Proxy information used for the management station configuration.
      properties:
        forward:
          description: The URL the proxy will forward to.
          type: string
        hosts:
          description: List of hosts.
          items:
            type: string
          maxItems: 255
          type: array
        isEnabled:
          description: Indicates if the proxy should be enabled or disabled. Default is enabled.
          type: boolean
        port:
          description: Listening port used for the proxy.
          type: string
      required:
      - isEnabled
      type: object
    MirrorSyncStatus:
      description: Status summary of the mirror sync.
      properties:
        failed:
          description: Total number of software sources that failed to sync.
          type: integer
        queued:
          description: Total number of software sources that are queued for sync.
          type: integer
        synced:
          description: Total number of software sources that successfully synced.
          type: integer
        syncing:
          description: Total number of software sources currently syncing.
          type: integer
        unsynced:
          description: Total number of software sources that have not yet been synced.
          type: integer
      required:
      - unsynced
      - queued
      - syncing
      - synced
      - failed
      type: object
    MirrorSummary:
      description: Provides summary information for a software source mirror.
      properties:
        archType:
          description: The architecture type supported by the software source.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        displayName:
          description: Display name of the mirror.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source.
          type: string
        log:
          description: The current log from the management station plugin.
          type: string
        osFamily:
          description: The OS family of the software source.
          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'
        packageCount:
          description: The number of packages within the mirrored software source.
          type: integer
        percentage:
          description: A decimal number representing the percentage of the software source that has been synced.
          type: integer
        size:
          description: The size the mirrored software source in bytes.
          format: int64
          type: integer
        state:
          description: Current state of the software source mirror.
          enum:
          - UNSYNCED
          - QUEUED
          - SYNCING
          - SYNCED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/MirrorState'
        timeLastSynced:
          description: 'Time that the software source was last synced (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).

            '
          format: date-time
          type: string
        type:
          description: Type of software source.
          enum:
          - CUSTOM
          - VENDOR
          - VERSIONED
          - PRIVATE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/MirrorType'
      required:
      - id
      - state
      - percentage
      - timeLastSynced
      - log
      - packageCount
      - size
      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
    UpdateProxyConfigurationDetails:
      allOf:
      - $ref: '#/components/schemas/CreateProxyConfigurationDetails'
      description: Provides the information used to update the proxy configuration for a management station.
    PeerManagementStation:
      description: "A list of other management stations that are behind the same load balancer within a high availability \nconfiguration. Stations are identified as peers if they have the same hostname and compartment.\n"
      properties:
        displayName:
          description: User-friendly name for the management station.
          format: x-obmcs-ascii-identifier
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station.
          type: string
      required:
      - id
      - displayName
      type: object
    ManagementStationSummary:
      description: Provides summary information for a management station.
      properties:
        archType:
          description: The architecture type.
          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 management station.
          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 description of the management station.
          type: string
        displayName:
          description: User-friendly name for the management station.
          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
        healthState:
          description: Overall health status of the managment station.
          enum:
          - HEALTHY
          - UNHEALTHY
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/HealthState'
        hostname:
          description: Hostname of the management station.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station.
          type: string
        lifecycleState:
          description: The current state of the management station.
          type: string
          x-obmcs-enumref: '#/definitions/ManagementStation/lifecycleState'
        location:
          description: The location of the instance that is acting as the management station.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        managedInstanceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance that is acting as the management station.
          type: string
        mirrorCapacity:
          description: A decimal number representing the amount of mirror capacity used by the sync.
          type: integer
        osFamily:
          description: The operating system family.
          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'
        overallPercentage:
          description: A decimal number representing the progress of the current mirror sync.
          type: integer
        overallState:
          description: Current state of the mirror sync for the management station.
          enum:
          - NORMAL
          - REGISTRATIONERROR
          - SYNCING
          - SYNCFAILED
          - WARNING
          - ERROR
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OverallState'
        profileId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile used for the management station.
          type: string
        scheduledJobId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job for the mirror sync.
          type: string
        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
        timeNextExecution:
          description: The date and time of the next scheduled mirror sync (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format).
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - hostname
      type: object
    ManagementStation:
      description: Provides information about the management station, including name, state, and configuration.
      properties:
        archType:
          description: The architecture type.
          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 management station.
          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 description for the management station.
          type: string
        displayName:
          description: A user-friendly name for the management station.
          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
        health:
          $ref: '#/components/schemas/StationHealth'
        hostname:
          description: Hostname of the management station.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station.
          type: string
        isAutoConfigEnabled:
          description: When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station.
          type: boolean
        lifecycleState:
          description: The current state of the management station.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        location:
          description: The location of the instance that is acting as the management station.
          enum:
          - ON_PREMISE
          - OCI_COMPUTE
          - AZURE
          - EC2
          - GCP
          type: string
          x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation'
        managedInstanceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance that is acting as the management station.
          type: string
        mirror:
          $ref: '#/components/schemas/MirrorConfiguration'
        mirrorCapacity:
          description: A decimal number representing the amount of mirror capacity used by the sync.
          type: integer
        mirrorPackageCount:
          description: The total number of all packages within the mirrored software sources.
          type: integer
        mirrorSize:
          description: The total size of all software source mirrors in bytes.
          format: int64
          type: integer
        mirrorStorageAvailableSize:
          description: Amount of available mirror storage in bytes.
          format: int64
          type: integer
        mirrorStorageSize:
          description: Total mirror storage size in bytes.
          format: int64
          type: integer
        mirrorSyncStatus:
          $ref: '#/components/schemas/MirrorSyncStatus'
        mirrorUniquePackageCount:
          description: The total number of unique packages within the mirrored software sources on the station. Each package is counted only once, regardless of how many versions it has.
          type: integer
        osFamily:
          description: The operating system family.
          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'
        overallPercentage:
          description: A decimal number representing the progress of the current mirror sync.
          type: integer
        overallState:
          description: Current state of the mirror sync for the management station.
          enum:
          - NORMAL
          - REGISTRATIONERROR
          - SYNCING
          - SYNCFAILED
          - WARNING
          - ERROR
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/OverallState'
        peerManagementStations:
          description: A list of other management stations that are behind the same load balancer within a high availability configuration. Stations are identified as peers if they have the same hostname and compartment.
          items:
            $ref: '#/components/schemas/PeerManagementStation'
          type: array
        profileId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the registration profile used for the management station.
          type: string
        proxy:
          $ref: '#/components/schemas/ProxyConfiguration'
        scheduledJobId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the scheduled job for the mirror sync.
          type: string
        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
        totalMirrors:
          description: The number of software sources that the station is mirroring.
          type: integer
      required:
      - id
      - compartmentId
      - displayName
      - hostname
      - proxy
      - mirror
      - peerManagementStations
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n  \"definedTags\": {},\n  \"description\": \"example description\",\n  \"displayName\": \"example-name\",\n  \"freeformTags\": {},\n  \"health\": {\n    \"description\": \"Station agent setup succeeded and the underlying managed instance is 'Active'.\",\n    \"state\": \"HEALTHY\"\n  },\n  \"hostname\": \"example-hostname\",\n  \"id\": \"ocid1.osmhmanagementstation.oc1.phx.exampleuniqueID\",\n  \"isAutoConfigEnabled\": false,\n  \"lifecycleState\": \"ACTIVE\",\n  \"location\": ON_PREMISE,\n  \"managedInstanceId\": \"ocid1.managementagent.oc1.phx.exampleuniqueID\",\n  \"mirror\": {\n    \"directory\": \"/example/path\",\n    \"isSslverifyEnabled\": false,\n    \"port\": \"50001\",\n    \"sslcert\": null,\n    \"sslport\": \"50002\"\n  },\n  \"mirrorCapacity\": 10,\n  \"mirrorPackageCount\": 154822,\n  \"mirrorSize\": 5104473101209,\n  \"mirrorStorageAvailableSize\": 0,\n  \"mirrorStorageSize\": 0,\n  \"mirrorSyncStatus\": {\n    \"failed\": 0,\n    \"queued\": 2,\n    \"synced\": 8,\n    \"syncing\": 0,\n    \"unsynced\": 0\n  },\n  \"mirrorUniquePackageCount\": 9086,\n  \"osFamily\": \"ORACLE_LINUX_8\",\n  archType\": \"X86_64\",\n  \"overallPercentage\": 80,\n  \"overallState\": \"SYNCING\",\n  \"peerManagementStations\": [\n    {\n      \"id\": \"ocid1.osmhmanagementstation.oc1.phx.exampleuniqueID\",\n      \"displayName\": \"example-name\"\n    }\n  ],\n  \"profileId\": \"ocid1.osmhprofile.oc1.phx.exampleuniqueID\",\n  \"proxy\": {\n    \"forward\": null,\n    \"hosts\": [\n      \"0.0.0.0/0\"\n    ],\n    \"isEnabled\": true,\n    \"port\": \"8080\"\n  },\n  \"scheduledJobId\": ocid1.osmhscheduledjob.oc1.phx.exampleuniqueID,\n  \"systemTags\": {},\n  \"totalMirrors\": 0\n}\n"
    UpdateManagementStationDetails:
      description: Provides the information used to update the management station.
      properties:
        archType:
          description: The architecture type.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          maxLength: 255
          minLength: 1
          type: string
          x-obmcs-top-level-enum: '#/definitions/ArchType'
        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 description of the management station. Avoid entering confidential information.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the management station. 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
        hostname:
          description: Hostname of the management station.
          maxLength: 255
          type: string
        isAutoConfigEnabled:
          default: false
          description: When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station.
          type: boolean
        mirror:
          $ref: '#/components/schemas/UpdateMirrorConfigurationDetails'
        osFamily:
          description: The operating system family.
          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
          maxLength: 255
          minLength: 1
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        proxy:
          $ref: '#/components/schemas/UpdateProxyConfigurationDetails'
      type: object
    CreateManagementStationDetails:
      description: Provides the information used to create a management station.
      properties:
        archType:
          description: The architecture type.
          enum:
          - X86_64
          - AARCH64
          - I686
          - NOARCH
          - SRC
          - I386
          - AMD64
          - ARM64
          - ALL
          maxLength: 255
          minLength: 1
          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 management station.
          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 description of the management station. Avoid entering confidential information.
          maxLength: 400
          type: string
        displayName:
          description: User-friendly name for the management station. 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
        hostname:
          description: Hostname of the management station.
          maxLength: 255
          type: string
        isAutoConfigEnabled:
          default: false
          description: When enabled, the station setup script automatically runs to configure the firewall and SELinux settings on the station.
          type: boolean
        mirror:
          $ref: '#/components/schemas/CreateMirrorConfigurationDetails'
        osFamily:
          description: The operating system family.
          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
          maxLength: 255
          minLength: 1
          type: string
          x-obmcs-top-level-enum: '#/definitions/OsFamily'
        proxy:
          $ref: '#/components/schemas/CreateProxyConfigurationDetails'
      required:
      - compartmentId
      - displayName
      - hostname
      - proxy
      - mirror
      type: object
    CreateMirrorConfigurationDetails:
      description: Information used to create the mirror configuration for a management station.
      properties:
        directory:
          description: Path to the data volume on the management station where software source mirrors are stored.
          maxLength: 255
          minLength: 1
          pattern: ^/|//|(/[\w-]+)+$
          type: string
        isSslverifyEnabled:
          default: false
          description: When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station.
          type: boolean
        port:
          description: Default mirror listening port for http.
          maxLength: 255
          minLength: 1
          type: string
        sslcert:
          description: Path to the SSL cerfificate.
          maxLength: 255
          type: string
        sslport:
          description: Default mirror listening port for https.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - directory
      - port
      - sslport
      type: object
    ManagementStationCollection:
      description: A set of management stations returned for the [ListManagementStations](#/en/osmh/latest/ManagementStation/ListManagementStations) operation.
      properties:
        items:
          description: List of management stations.
          items:
            $ref: '#/components/schemas/ManagementStationSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n      \"definedTags\": {},\n      \"description\": \"example description\",\n      \"displayName\": \"example-name\",\n      \"freeformTags\": {},\n      \"healthState\": \"HEALTHY\",\n      \"hostname\": \"example-hostname\",\n      \"id\": \"ocid1.osmhmanagementstation.oc1.phx.exampleuniqueID\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"location\": \"ON_PREMISE\",\n      \"managedInstanceId\": \"ocid1.managementagent.oc1.phx.exampleuniqueID\",\n      \"mirrorCapacity\": 10,\n      \"osFamily\": \"ORACLE_LINUX_8\",\n      \"archType\": \"X86_64\",\n      \"overallPercentage\": 80,\n      \"overallState\": \"SYNCING\",\n      \"profileId\": \"ocid1.osmhprofile.oc1.phx.exampleuniqueID\",\n      \"scheduledJobId\": ocid1.osmhscheduledjob.oc1.phx.exampleuniqueID,\n      \"systemTags\": {},\n      \"timeNextExecution\": \"2025-02-16T00:00:00.000Z\"\n    }\n  ]\n}\n"
    SynchronizeMirrorsDetails:
      description: Detailed information about software source mirrors to be synced.
      properties:
        softwareSourceList:
          description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to synchronize.
          items:
            type: string
          type: array
      required:
      - softwareSourceList
      type: object
    CreateProxyConfigurationDetails:
      description: Information used to create the proxy configuration for a management station.
      properties:
        forward:
          description: The URL the proxy will forward to.
          type: string
        hosts:
          description: List of hosts.
          items:
            type: string
          maxItems: 255
          type: array
        isEnabled:
          description: Indicates if the proxy should be enabled or disabled. Default is enabled.
          type: boolean
        port:
          description: Listening port used for the proxy.
          type: string
      required:
      - isEnabled
      type: object
    StationHealth:
      description: Overall health information of the management station.
      properties:
        description:
          description: Explanation of the health status.
          maxLength: 400
          type: string
        state:
          description: Overall health status of the management station.
          enum:
          - HEALTHY
          - UNHEALTHY
          - UNAVAILABLE
          type: string
          x-obmcs-top-level-enum: '#/definitions/HealthState'
      required:
      - state
      type: object
    MirrorConfiguration:
      description: Mirror information used for the management station configuration.
      properties:
        directory:
          description: Path to the data volume on the management station where software source mirrors are stored.
          maxLength: 255
          minLength: 1
          pattern: ^/|//|(/[\w-]+)+$
          type: string
        isSslverifyEnabled:
          description: When enabled, the SSL certificate is verified whenever an instance installs or updates a package from a software source that is mirrored on the management station.
          type: boolean
        port:
          description: Default mirror listening port for http.
          maxLength: 255
          minLength: 1
          type: string
        sslcert:
          description: Path to the SSL cerfificate.
          type: string
        sslport:
          description: Default mirror listening port for https.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - directory
      - port
      - sslport
      type: object
  parameters:
    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
    MirrorStatesQueryParam:
      description: List of Mirror state to filter by
      in: query
      name: mirrorStates
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - UNSYNCED
          - QUEUED
          - SYNCING
          - SYNCED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/MirrorState'
    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
    ManagementStationIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station.
      in: path
      name: managementStationId
      required: true
      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
    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
    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
    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
    ManagementStationIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the management station. A filter that returns information about the specified management station.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    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
    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
    ManagementStationLifecycleStateQueryParam:
      description: A filter that returns information for management stations in the specified state.
      in: query
      name: lifecycleState
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/ManagementStation/lifecycleState'
      schema:
        type: string
    DisplayNameQueryParam:
      description: A filter to return resources that match the given user-friendly name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ManagementStationSortByQueryParam:
      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. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    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
    ManagedInstanceIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance.
      in: query
      name: managedInstanceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ChangeManagementStationCompartmentDetailsParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the management station to.
      in: body
      name: ChangeManagementStationCompartmentDetails
      required: true
      schema:
        $ref: '#/components/schemas/ChangeManagementStationCompartmentDetails'
    HealthStateQueryParam:
      description: A filter that returns information for management stations in the specified health state.
      in: query
      name: healthState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/HealthState'
      schema:
        type: string
        enum:
        - HEALTHY
        - UNHEALTHY
        - UNAVAILABLE
    MirrorIdentifierPathParam:
      description: Unique Software Source identifier
      in: path
      name: mirrorId
      required: true
      schema:
        type: string
  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