Oracle Management Station API

The managementStation API from Oracle — 7 operation(s) for managementstation.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-managementstation-api-openapi.yml Raw ↑
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:
       

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-managementstation-api-openapi.yml