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-firmware-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

openapi: 3.2.0
info:
  title: RomM Firmware API
  version: 5.4.0
tags:
- name: Firmware
paths:
  /api/firmware:
    post:
      tags:
      - Firmware
      summary: Add Firmware
      description: 'Upload firmware files endpoint


        Args:

        request (Request): Fastapi Request object

        platform_slug (str): Slug of the platform where to upload the files

        files (list[UploadFile], optional): List of files to upload


        Raises:

        HTTPException


        Returns:

        AddFirmwareResponse: Standard message response'
      operationId: add_firmware_api_firmware_post
      security:
      - OAuth2PasswordBearer:
        - firmware.write
      - HTTPBasic: []
      parameters:
      - name: platform_id
        in: query
        required: true
        schema:
          type: integer
          title: Platform Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_add_firmware_api_firmware_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddFirmwareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Firmware
      summary: Get Platform Firmware
      description: 'Get firmware endpoint


        Args:

        request (Request): Fastapi Request object


        Returns:

        list[FirmwareSchema]: Firmware stored in the database'
      operationId: get_platform_firmware_api_firmware_get
      security:
      - OAuth2PasswordBearer:
        - firmware.read
      - HTTPBasic: []
      parameters:
      - name: platform_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Platform Id
      - name: missing
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the firmware is missing from the filesystem.
          title: Missing
        description: Whether the firmware is missing from the filesystem.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FirmwareSchema'
                title: Response Get Platform Firmware Api Firmware Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/firmware/identifiers:
    get:
      tags:
      - Firmware
      summary: Get Firmware Identifiers
      description: 'Get firmware identifiers endpoint


        Args:

        request (Request): Fastapi Request object


        Returns:

        list[int]: List of firmware IDs'
      operationId: get_firmware_identifiers_api_firmware_identifiers_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  type: integer
                type: array
                title: Response Get Firmware Identifiers Api Firmware Identifiers Get
      security:
      - OAuth2PasswordBearer:
        - firmware.read
      - HTTPBasic: []
  /api/firmware/{id}:
    get:
      tags:
      - Firmware
      summary: Get Firmware
      description: 'Get firmware endpoint


        Args:

        request (Request): Fastapi Request object

        id (int): Firmware internal id


        Returns:

        FirmwareSchema: Firmware stored in the database'
      operationId: get_firmware_api_firmware__id__get
      security:
      - OAuth2PasswordBearer:
        - firmware.read
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          title: Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FirmwareSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/firmware/{id}/content/{file_name}:
    head:
      tags:
      - Firmware
      summary: Head Firmware Content
      description: 'Head firmware content endpoint


        Args:

        request (Request): Fastapi Request object

        id (int): Rom internal id

        file_name (str): Required due to a bug in emulatorjs


        Returns:

        FileResponse: Returns the response with headers'
      operationId: head_firmware_content_api_firmware__id__content__file_name__head
      security:
      - OAuth2PasswordBearer:
        - firmware.read
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          title: Id
      - name: file_name
        in: path
        required: true
        schema:
          type: string
          title: File Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Firmware
      summary: Get Firmware Content
      description: 'Download firmware endpoint


        Args:

        request (Request): Fastapi Request object

        id (int): Rom internal id

        file_name (str): Required due to a bug in emulatorjs


        Returns:

        FileResponse: Returns the firmware file'
      operationId: get_firmware_content_api_firmware__id__content__file_name__get
      security:
      - OAuth2PasswordBearer:
        - firmware.read
      - HTTPBasic: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          title: Id
      - name: file_name
        in: path
        required: true
        schema:
          type: string
          title: File Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/firmware/delete:
    post:
      tags:
      - Firmware
      summary: Delete Firmware
      description: Delete firmware.
      operationId: delete_firmware_api_firmware_delete_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_delete_firmware_api_firmware_delete_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkOperationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - firmware.write
      - HTTPBasic: []
components:
  schemas:
    AddFirmwareResponse:
      properties:
        uploaded:
          type: integer
          title: Uploaded
        firmware:
          items:
            $ref: '#/components/schemas/FirmwareSchema'
          type: array
          title: Firmware
      type: object
      required:
      - uploaded
      - firmware
      title: AddFirmwareResponse
    Body_delete_firmware_api_firmware_delete_post:
      properties:
        firmware:
          items:
            type: integer
          type: array
          title: Firmware
          description: List of firmware ids to delete from database.
        delete_from_fs:
          items:
            type: integer
          type: array
          title: Delete From Fs
          description: List of firmware ids to delete from filesystem.
      type: object
      required:
      - firmware
      title: Body_delete_firmware_api_firmware_delete_post
    BulkOperationResponse:
      properties:
        successful_items:
          type: integer
          title: Successful Items
        failed_ids:
          items:
            type: integer
          type: array
          title: Failed Ids
        errors:
          items:
            type: string
          type: array
          title: Errors
      type: object
      required:
      - successful_items
      - failed_ids
      - errors
      title: BulkOperationResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FirmwareSchema:
      properties:
        id:
          type: integer
          title: Id
        platform_id:
          type: integer
          title: Platform Id
        file_name:
          type: string
          title: File Name
        file_name_no_tags:
          type: string
          title: File Name No Tags
        file_name_no_ext:
          type: string
          title: File Name No Ext
        file_extension:
          type: string
          title: File Extension
        file_path:
          type: string
          title: File Path
        file_size_bytes:
          type: integer
          title: File Size Bytes
        full_path:
          type: string
          title: Full Path
        is_verified:
          type: boolean
          title: Is Verified
        crc_hash:
          type: string
          title: Crc Hash
        md5_hash:
          type: string
          title: Md5 Hash
        sha1_hash:
          type: string
          title: Sha1 Hash
        missing_from_fs:
          type: boolean
          title: Missing From Fs
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      type: object
      required:
      - id
      - platform_id
      - file_name
      - file_name_no_tags
      - file_name_no_ext
      - file_extension
      - file_path
      - file_size_bytes
      - full_path
      - is_verified
      - crc_hash
      - md5_hash
      - sha1_hash
      - missing_from_fs
      - created_at
      - updated_at
      title: FirmwareSchema
    Body_add_firmware_api_firmware_post:
      properties:
        files:
          items:
            type: string
            contentMediaType: application/octet-stream
          type: array
          title: Files
      type: object
      required:
      - files
      title: Body_add_firmware_api_firmware_post
    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
  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