RomM

RomM Devices API

The devices API from RomM — 6 operation(s) for devices.

GitHub OpenAPI

Operations 11

GET /api/devices/online Get Online Devices #
POST /api/devices/{device_id}/installs Create Install Request #
GET /api/devices/{device_id}/installs List Install Requests #
POST /api/devices/{device_id}/installs/claim Claim Install Requests #
PUT /api/devices/{device_id}/installs/{request_id} Update Install Request #
DELETE /api/devices/{device_id}/installs/{request_id} Cancel Install Request #
GET /api/devices Get Devices #
POST /api/devices Register Device #
GET /api/devices/{device_id} Get Device #
PUT /api/devices/{device_id} Update Device #
DELETE /api/devices/{device_id} Delete Device #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/romm/openapi/romm-devices-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-detailed-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-simple-rom-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-config-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-body-update-rom-api-roms-id-put-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-platform-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/romm/json-schema/romm-search-rom-schema-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/romm:romm-devices-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

romm-devices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: RomM Devices API
  version: 5.4.0
tags:
- name: Devices
paths:
  /api/devices/online:
    get:
      tags:
      - Devices
      summary: Get Online Devices
      description: Ids of the caller's devices holding an open device socket or that claimed lately.
      operationId: get_online_devices_api_devices_online_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
                title: Response Get Online Devices Api Devices Online Get
        '404':
          description: Not Found
      security:
      - OAuth2PasswordBearer:
        - devices.read
      - HTTPBasic: []
  /api/devices/{device_id}/installs:
    post:
      tags:
      - Devices
      summary: Create Install Request
      description: Queue a rom for install on a device, returning a live request for the same pair with 200.
      operationId: create_install_request_api_devices__device_id__installs_post
      security:
      - OAuth2PasswordBearer:
        - devices.write
        - roms.read
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          description: Target device id.
          title: Device Id
        description: Target device id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallRequestCreatePayload'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallRequestSchema'
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallRequestSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '409':
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Devices
      summary: List Install Requests
      description: The device's pending and taken requests, oldest first.
      operationId: list_install_requests_api_devices__device_id__installs_get
      security:
      - OAuth2PasswordBearer:
        - devices.read
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          description: Target device id.
          title: Device Id
        description: Target device id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InstallRequestSchema'
                title: Response List Install Requests Api Devices  Device Id  Installs Get
        '404':
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/devices/{device_id}/installs/claim:
    post:
      tags:
      - Devices
      summary: Claim Install Requests
      description: Take every pending request and return all the device holds taken, oldest first.
      operationId: claim_install_requests_api_devices__device_id__installs_claim_post
      security:
      - OAuth2PasswordBearer:
        - devices.write
        - roms.read
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          description: Target device id.
          title: Device Id
        description: Target device id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InstallRequestSchema'
                title: Response Claim Install Requests Api Devices  Device Id  Installs Claim Post
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '409':
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/devices/{device_id}/installs/{request_id}:
    put:
      tags:
      - Devices
      summary: Update Install Request
      description: The device reports the outcome of a request it has taken, which ends the request.
      operationId: update_install_request_api_devices__device_id__installs__request_id__put
      security:
      - OAuth2PasswordBearer:
        - devices.write
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          description: Target device id.
          title: Device Id
        description: Target device id.
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          description: Install request id.
          title: Request Id
        description: Install request id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallRequestUpdatePayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallRequestSchema'
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '409':
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Devices
      summary: Cancel Install Request
      description: Cancel a request still pending or taken; one already ended is a 404.
      operationId: cancel_install_request_api_devices__device_id__installs__request_id__delete
      security:
      - OAuth2PasswordBearer:
        - devices.write
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          description: Target device id.
          title: Device Id
        description: Target device id.
      - name: request_id
        in: path
        required: true
        schema:
          type: string
          description: Install request id.
          title: Request Id
        description: Install request id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallRequestSchema'
        '404':
          description: Not Found
        '409':
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/devices:
    get:
      tags:
      - Devices
      summary: Get Devices
      operationId: get_devices_api_devices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DeviceSchema'
                type: array
                title: Response Get Devices Api Devices Get
      security:
      - OAuth2PasswordBearer:
        - devices.read
      - HTTPBasic: []
    post:
      tags:
      - Devices
      summary: Register Device
      operationId: register_device_api_devices_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceCreatePayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - devices.write
      - HTTPBasic: []
  /api/devices/{device_id}:
    get:
      tags:
      - Devices
      summary: Get Device
      operationId: get_device_api_devices__device_id__get
      security:
      - OAuth2PasswordBearer:
        - devices.read
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          title: Device Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Devices
      summary: Update Device
      operationId: update_device_api_devices__device_id__put
      security:
      - OAuth2PasswordBearer:
        - devices.write
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          title: Device Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceUpdatePayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Devices
      summary: Delete Device
      operationId: delete_device_api_devices__device_id__delete
      security:
      - OAuth2PasswordBearer:
        - devices.write
      - HTTPBasic: []
      parameters:
      - name: device_id
        in: path
        required: true
        schema:
          type: string
          title: Device Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    InstallStatus:
      type: string
      enum:
      - pending
      - taken
      - done
      - already_installed
      - failed
      - cancelled
      title: InstallStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InstallRequestUpdatePayload:
      properties:
        status:
          $ref: '#/components/schemas/InstallStatus'
        reason:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Reason
      type: object
      required:
      - status
      title: InstallRequestUpdatePayload
    DeviceCreateResponse:
      properties:
        device_id:
          type: string
          title: Device Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - device_id
      - name
      - created_at
      title: DeviceCreateResponse
    InstallRequestSchema:
      properties:
        id:
          type: string
          title: Id
        user_id:
          type: integer
          title: User Id
        device_id:
          type: string
          title: Device Id
        rom_id:
          type: integer
          title: Rom Id
        file_ids:
          items:
            type: integer
          type: array
          title: File Ids
        status:
          $ref: '#/components/schemas/InstallStatus'
        reason:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Reason
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - user_id
      - device_id
      - rom_id
      - file_ids
      - status
      - reason
      - created_at
      - updated_at
      title: InstallRequestSchema
      description: An install request, as served and as stored in Redis while pending or taken.
    DeviceCreatePayload:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        client:
          anyOf:
          - type: string
          - type: 'null'
          title: Client
        client_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Version
        ip_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Ip Address
        mac_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Mac Address
        hostname:
          anyOf:
          - type: string
          - type: 'null'
          title: Hostname
        sync_mode:
          anyOf:
          - $ref: '#/components/schemas/SyncMode'
          - type: 'null'
        sync_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Sync Config
        capabilities:
          anyOf:
          - additionalProperties:
              type: boolean
            propertyNames:
              maxLength: 64
              minLength: 1
            type: object
            maxProperties: 32
          - type: 'null'
          title: Capabilities
        allow_existing:
          type: boolean
          title: Allow Existing
          default: true
        allow_duplicate:
          type: boolean
          title: Allow Duplicate
          default: false
        reset_syncs:
          type: boolean
          title: Reset Syncs
          default: false
      type: object
      title: DeviceCreatePayload
    DeviceUpdatePayload:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        client:
          anyOf:
          - type: string
          - type: 'null'
          title: Client
        client_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Version
        ip_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Ip Address
        mac_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Mac Address
        hostname:
          anyOf:
          - type: string
          - type: 'null'
          title: Hostname
        sync_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Sync Enabled
        sync_mode:
          anyOf:
          - $ref: '#/components/schemas/SyncMode'
          - type: 'null'
        sync_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Sync Config
        capabilities:
          anyOf:
          - additionalProperties:
              type: boolean
            propertyNames:
              maxLength: 64
              minLength: 1
            type: object
            maxProperties: 32
          - type: 'null'
          title: Capabilities
      type: object
      title: DeviceUpdatePayload
    SyncMode:
      type: string
      enum:
      - api
      - file_transfer
      - push_pull
      title: SyncMode
    InstallRequestCreatePayload:
      properties:
        rom_id:
          type: integer
          minimum: 1.0
          title: Rom Id
      type: object
      required:
      - rom_id
      title: InstallRequestCreatePayload
    DeviceSchema:
      properties:
        id:
          type: string
          title: Id
        user_id:
          type: integer
          title: User Id
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        client:
          anyOf:
          - type: string
          - type: 'null'
          title: Client
        client_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Version
        ip_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Ip Address
        mac_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Mac Address
        hostname:
          anyOf:
          - type: string
          - type: 'null'
          title: Hostname
        client_device_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Device Identifier
        sync_mode:
          $ref: '#/components/schemas/SyncMode'
        sync_enabled:
          type: boolean
          title: Sync Enabled
        sync_config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Sync Config
        capabilities:
          anyOf:
          - additionalProperties:
              type: boolean
            type: object
          - type: 'null'
          title: Capabilities
        last_seen:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Seen
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - user_id
      - name
      - platform
      - client
      - client_version
      - ip_address
      - mac_address
      - hostname
      - client_device_identifier
      - sync_mode
      - sync_enabled
      - sync_config
      - capabilities
      - last_seen
      - created_at
      - updated_at
      title: DeviceSchema
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            me.read: View your profile
            roms.read: View ROMs
            platforms.read: View platforms
            assets.read: View assets
            devices.read: View devices
            firmware.read: View firmware
            roms.user.read: View user-rom properties
            collections.read: View collections
            playlists.read: View music playlists
            me.write: Modify your profile
            assets.write: Modify assets
            devices.write: Modify devices
            roms.user.write: Modify user-rom properties
            collections.write: Modify collections
            playlists.write: Modify music playlists
            roms.write: Modify ROMs
            platforms.write: Modify platforms
            firmware.write: Modify firmware
            users.read: View users
            users.write: Modify users
            tasks.run: Run tasks
            logs.read: View backend logs
          tokenUrl: /token
    HTTPBasic:
      type: http
      scheme: basic