openapi: 3.2.0
info:
  description: Use the OCI Managed Services for Mac API to create and manage orders for dedicated, partially-managed Mac servers hosted in an OCI Data Center. To learn more about the service, see the [OCI Managed Services for Mac documentation](https://docs.oracle.com/en-us/iaas/Content/managed-mac/home.htm).
  title: OCI Managed Services for Mac Mac Device API
  version: '20250320'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/9ddea3093fd3564bac7128a88f62ab50750d17916eb1a9c18fb85144868ac15d.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OCI Managed Services for Mac 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/9ddea3093fd3564bac7128a88f62ab50750d17916eb1a9c18fb85144868ac15d.yaml
    what: the harvested document for OCI Managed Services for Mac API
servers:
- url: http://127.0.0.1/20250320
- url: https://127.0.0.1/20250320
tags:
- name: macDevice
paths:
  /macOrders/{macOrderId}/macDevices:
    get:
      description: 'Gets a list of MacDevices assigned to this order.

        '
      operationId: ListMacDevices
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/MacOrderIdentifierPathParam'
      - $ref: '#/components/parameters/MacDeviceIdentifierQueryParam'
      - $ref: '#/components/parameters/SerialNumberQueryParam'
      - $ref: '#/components/parameters/MacDeviceLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/DeviceSortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of MacDeviceSummary objects.
          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/MacDeviceCollection'
        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 MacDevices.
      tags:
      - macDevice
      x-related-resource: '#/definitions/MacDeviceCollection'
  /macOrders/{macOrderId}/macDevices/{macDeviceId}:
    get:
      description: Gets information about a MacDevice.
      operationId: GetMacDevice
      parameters:
      - $ref: '#/components/parameters/MacDeviceIdentifierPathParam'
      - $ref: '#/components/parameters/MacOrderIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The MacDevice was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MacDevice'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get MacDevice
      tags:
      - macDevice
  /macOrders/{macOrderId}/macDevices/{macDeviceId}/actions/terminate:
    post:
      description: Terminates a MacDevice.
      operationId: TerminateMacDevice
      parameters:
      - $ref: '#/components/parameters/MacDeviceIdentifierPathParam'
      - $ref: '#/components/parameters/MacOrderIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: Accepted the request. The MacDevice will be terminated.
          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: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        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: Terminates a MacDevice.
      tags:
      - macDevice
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/MacDevice'
components:
  parameters:
    CompartmentIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the

        `if-match` parameter to the value of the etag from a previous GET or POST response for

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

        matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    SerialNumberQueryParam:
      description: The serial number of the MacDevice.
      in: query
      name: serialNumber
      x-default-description: 'null'
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      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).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    MacDeviceIdentifierQueryParam:
      description: The UUID of the MacDevice.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of running 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 removed 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
    MacDeviceLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The

        state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/MacDevice/lifecycleState'
      schema:
        type: string
    MacOrderIdentifierPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the MacOrder.
      in: path
      name: macOrderId
      required: true
      schema:
        type: string
    MacDeviceIdentifierPathParam:
      description: The UUID of the MacDevice.
      in: path
      name: macDeviceId
      required: true
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either ascending (`ASC`) or descending (`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
    DeviceSortByQueryParam:
      description: "The field to sort by. You can provide only one sort order. Default order for `timeCreated` \nis descending. Default order for `SerialNumber` is ascending.\n"
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - SerialNumber
        default: timeCreated
  schemas:
    MacDeviceCollection:
      description: Results of a MacDevice search. Contains both MacDeviceSummary items and other information, such as metadata.
      properties:
        items:
          description: List of MacDevices.
          items:
            $ref: '#/components/schemas/MacDeviceSummary'
          type: array
      required:
      - items
      type: object
    MacDeviceSummary:
      description: Summary information about a MacDevice.
      properties:
        compartmentId:
          description: OCID of the compartment to which the resource belongs to.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The unique ID of the MacDevice.
          type: string
        ipAddress:
          description: The IP address assigned to the MacDevice.
          type: string
        isMarkedDecom:
          default: false
          description: A flag that indicates if this MacDevice is decommissioned.
          type: boolean
        lifecycleState:
          description: The current status of the MacDevice.
          type: string
          x-obmcs-enumref: '#/definitions/MacDevice/lifecycleState'
        macOrderId:
          description: The OCID of the resource.
          maxLength: 255
          minLength: 1
          type: string
        serialNumber:
          description: The serial number of the MacDevice.
          type: string
        shape:
          description: The shape of the MacDevice.
          type: string
          x-obmcs-enumref: '#/definitions/MacOrder/shape'
        timeCreated:
          description: The time this resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeDecom:
          description: An RFC3339-formatted datetime string containing the time this MacDevice was decommissioned.
          format: date-time
          type: string
        timeUpdated:
          description: The time this resource was last updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - macOrderId
      - serialNumber
      - ipAddress
      - lifecycleState
      - shape
      - timeCreated
      - timeUpdated
      - isMarkedDecom
      - timeDecom
      type: object
    Error:
      description: Error information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error message.
          type: string
      required:
      - code
      - message
    MacDevice:
      description: 'Represents a MacDevice resource.

        '
      properties:
        compartmentId:
          description: OCID of the compartment to which the resource belongs to.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The unique ID of the MacDevice.
          type: string
        ipAddress:
          description: The IP address assigned to the MacDevice.
          type: string
        isMarkedDecom:
          default: false
          description: A flag that indicates if this MacDevice is decommissioned.
          type: boolean
        lifecycleState:
          description: The current status of the MacDevice.
          enum:
          - CREATING
          - ACTIVE
          - NEEDS_ATTENTION
          - DELETING
          - DELETED
          type: string
        macOrderId:
          description: The OCID of the resource.
          maxLength: 255
          minLength: 1
          type: string
        serialNumber:
          description: The serial number of the MacDevice.
          type: string
        shape:
          description: The shape of the Mac.
          type: string
          x-obmcs-enumref: '#/definitions/MacOrder/shape'
        timeCreated:
          description: The time this resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeDecom:
          description: An RFC3339-formatted datetime string containing the time this MacDevice was decommissioned.
          format: date-time
          type: string
        timeUpdated:
          description: The time this resource was last updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - macOrderId
      - serialNumber
      - ipAddress
      - lifecycleState
      - shape
      - timeCreated
      - timeUpdated
      - isMarkedDecom
      - timeDecom
      type: object
  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-work-request-id:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

        Use GetWorkRequest with this ID to track the status of the request.

        '
      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:
    compartmentId:
      description: OCID of the compartment to which the resource belongs to.
      maxLength: 255
      minLength: 1
      type: string
    displayName:
      description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

        Avoid entering confidential information.


        Example: `My new resource`

        '
      maxLength: 255
      minLength: 1
      type: string
    ipRange:
      description: The IP Range specified by the customer for this order.
      type: string
    isDocusigned:
      default: false
      description: Checkbox value that indicates whether the customer completed docusign process.
      type: boolean
    ocid:
      description: The OCID of the resource.
      maxLength: 255
      minLength: 1
      type: string
    orderDescription:
      description: 'A user-friendly description. To provide some insight about the resource.

        Avoid entering confidential information.

        '
      maxLength: 400
      type: string
    orderSize:
      description: Number of macs requested in this MacOrder.
      type: integer
    region:
      description: Associated region
      maxLength: 255
      type: string
      x-default-description: 'null'
    timeCreated:
      description: The time this resource was created. An RFC3339 formatted datetime string.
      format: date-time
      type: string
    timeUpdated:
      description: The time this resource was last updated. An RFC3339 formatted datetime string.
      format: date-time
      type: string
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oci.mngdmac.dev