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-config-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 Config API
  version: 5.4.0
tags:
- name: Config
paths:
  /api/config:
    get:
      tags:
      - Config
      summary: Get Config
      description: 'Get config endpoint


        Returns:

        ConfigResponse: RomM''s configuration'
      operationId: get_config_api_config_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
  /api/config/system/platforms:
    post:
      tags:
      - Config
      summary: Add Platform Binding
      description: Add platform binding to the configuration
      operationId: add_platform_binding_api_config_system_platforms_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformBindingPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
  /api/config/system/platforms/{fs_slug}:
    delete:
      tags:
      - Config
      summary: Delete Platform Binding
      description: Delete platform binding from the configuration
      operationId: delete_platform_binding_api_config_system_platforms__fs_slug__delete
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      parameters:
      - name: fs_slug
        in: path
        required: true
        schema:
          type: string
          title: Fs Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/config/system/versions:
    post:
      tags:
      - Config
      summary: Add Platform Version
      description: Add platform version to the configuration
      operationId: add_platform_version_api_config_system_versions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformBindingPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
  /api/config/system/versions/{fs_slug}:
    delete:
      tags:
      - Config
      summary: Delete Platform Version
      description: Delete platform version from the configuration
      operationId: delete_platform_version_api_config_system_versions__fs_slug__delete
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      parameters:
      - name: fs_slug
        in: path
        required: true
        schema:
          type: string
          title: Fs Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/config/exclude:
    post:
      tags:
      - Config
      summary: Add Exclusion
      description: Add platform exclusion to the configuration
      operationId: add_exclusion_api_config_exclude_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExclusionPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
  /api/config/exclude/{exclusion_type}/{exclusion_value}:
    delete:
      tags:
      - Config
      summary: Delete Exclusion
      description: Delete platform binding from the configuration
      operationId: delete_exclusion_api_config_exclude__exclusion_type___exclusion_value__delete
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
      parameters:
      - name: exclusion_type
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ExclusionType'
      - name: exclusion_value
        in: path
        required: true
        schema:
          type: string
          title: Exclusion Value
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/config/scan:
    put:
      tags:
      - Config
      summary: Update Scan Settings
      description: Replace the scan.* section of the configuration
      operationId: update_scan_settings_api_config_scan_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanSettingsPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
  /api/config/converto_settings:
    put:
      tags:
      - Config
      summary: Update Converto Settings
      description: Update the runtime-editable converto.* settings
      operationId: update_converto_settings_api_config_converto_settings_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConvertoSettingsPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - platforms.write
      - HTTPBasic: []
components:
  schemas:
    ConvertoSettingsPayload:
      properties:
        download_conversion_enabled:
          type: boolean
          title: Download Conversion Enabled
        cache_max_size_gb:
          type: integer
          minimum: 0.0
          title: Cache Max Size Gb
        platform_formats:
          additionalProperties:
            type: string
          type: object
          title: Platform Formats
      type: object
      required:
      - download_conversion_enabled
      - cache_max_size_gb
      - platform_formats
      title: ConvertoSettingsPayload
      description: Runtime-editable converto.* settings; `cache_ttl_hours` and `scan_metadata` stay in config.yml.
    MetadataMediaType:
      type: string
      enum:
      - bezel
      - box2d
      - box2d_back
      - box2d_side
      - box3d
      - miximage
      - miximage_v2
      - physical
      - screenshot
      - title_screen
      - marquee
      - logo
      - fanart
      - video
      - video_normalized
      - manual
      title: MetadataMediaType
    EjsControlsButton:
      properties:
        value:
          type: string
          title: Value
        value2:
          type: string
          title: Value2
      type: object
      title: EjsControlsButton
    EjsControls:
      properties:
        _0:
          additionalProperties:
            $ref: '#/components/schemas/EjsControlsButton'
          type: object
          title: '0'
        _1:
          additionalProperties:
            $ref: '#/components/schemas/EjsControlsButton'
          type: object
          title: '1'
        _2:
          additionalProperties:
            $ref: '#/components/schemas/EjsControlsButton'
          type: object
          title: '2'
        _3:
          additionalProperties:
            $ref: '#/components/schemas/EjsControlsButton'
          type: object
          title: '3'
      type: object
      required:
      - _0
      - _1
      - _2
      - _3
      title: EjsControls
    ExclusionType:
      type: string
      enum:
      - EXCLUDED_PLATFORMS
      - EXCLUDED_SINGLE_EXT
      - EXCLUDED_SINGLE_FILES
      - EXCLUDED_MULTI_FILES
      - EXCLUDED_MULTI_PARTS_EXT
      - EXCLUDED_MULTI_PARTS_FILES
      title: ExclusionType
      description: The `Config` fields an exclusion write may target.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NetplayICEServer:
      properties:
        urls:
          type: string
          title: Urls
        username:
          type: string
          title: Username
        credential:
          type: string
          title: Credential
      type: object
      required:
      - urls
      title: NetplayICEServer
    ConfigResponse:
      properties:
        CONFIG_FILE_MOUNTED:
          type: boolean
          title: Config File Mounted
        CONFIG_FILE_WRITABLE:
          type: boolean
          title: Config File Writable
        CONFIG_FILE_PARSE_ERROR:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File Parse Error
        EXCLUDED_PLATFORMS:
          items:
            type: string
          type: array
          title: Excluded Platforms
        EXCLUDED_SINGLE_EXT:
          items:
            type: string
          type: array
          title: Excluded Single Ext
        EXCLUDED_SINGLE_FILES:
          items:
            type: string
          type: array
          title: Excluded Single Files
        EXCLUDED_MULTI_FILES:
          items:
            type: string
          type: array
          title: Excluded Multi Files
        EXCLUDED_MULTI_PARTS_EXT:
          items:
            type: string
          type: array
          title: Excluded Multi Parts Ext
        EXCLUDED_MULTI_PARTS_FILES:
          items:
            type: string
          type: array
          title: Excluded Multi Parts Files
        DEFAULT_EXCLUDED_PLATFORM_DIRS:
          items:
            type: string
          type: array
          title: Default Excluded Platform Dirs
        DEFAULT_EXCLUDED_MULTI_FILE_DIRS:
          items:
            type: string
          type: array
          title: Default Excluded Multi File Dirs
        DEFAULT_EXCLUDED_FILES:
          items:
            type: string
          type: array
          title: Default Excluded Files
        DEFAULT_EXCLUDED_EXTENSIONS:
          items:
            type: string
          type: array
          title: Default Excluded Extensions
        PLATFORMS_BINDING:
          additionalProperties:
            type: string
          type: object
          title: Platforms Binding
        PLATFORMS_VERSIONS:
          additionalProperties:
            type: string
          type: object
          title: Platforms Versions
        SKIP_HASH_CALCULATION:
          type: boolean
          title: Skip Hash Calculation
        EJS_DEBUG:
          type: boolean
          title: Ejs Debug
        EJS_CACHE_LIMIT:
          anyOf:
          - type: integer
          - type: 'null'
          title: Ejs Cache Limit
        EJS_DISABLE_AUTO_UNLOAD:
          type: boolean
          title: Ejs Disable Auto Unload
        EJS_DISABLE_BATCH_BOOTUP:
          type: boolean
          title: Ejs Disable Batch Bootup
        EJS_ENABLE_AUTO_SAVE_SYNC:
          type: boolean
          title: Ejs Enable Auto Save Sync
        EJS_NETPLAY_ENABLED:
          type: boolean
          title: Ejs Netplay Enabled
        EJS_NETPLAY_ICE_SERVERS:
          items:
            $ref: '#/components/schemas/NetplayICEServer'
          type: array
          title: Ejs Netplay Ice Servers
        EJS_DEFAULT_CORES:
          additionalProperties:
            type: string
          type: object
          title: Ejs Default Cores
        EJS_SETTINGS:
          additionalProperties:
            additionalProperties:
              type: string
            type: object
          type: object
          title: Ejs Settings
        EJS_CONTROLS:
          additionalProperties:
            $ref: '#/components/schemas/EjsControls'
          type: object
          title: Ejs Controls
        SCAN_METADATA_PRIORITY:
          items:
            type: string
          type: array
          title: Scan Metadata Priority
        SCAN_ARTWORK_PRIORITY:
          items:
            type: string
          type: array
          title: Scan Artwork Priority
        SCAN_ARTWORK_PRIORITY_OVERRIDES:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Scan Artwork Priority Overrides
        SCAN_REGION_PRIORITY:
          items:
            type: string
          type: array
          title: Scan Region Priority
        SCAN_LANGUAGE_PRIORITY:
          items:
            type: string
          type: array
          title: Scan Language Priority
        SCAN_MEDIA:
          items:
            type: string
          type: array
          title: Scan Media
        GAMELIST_AUTO_EXPORT_ON_SCAN:
          type: boolean
          title: Gamelist Auto Export On Scan
        GAMELIST_MEDIA_THUMBNAIL:
          $ref: '#/components/schemas/MetadataMediaType'
        GAMELIST_MEDIA_IMAGE:
          $ref: '#/components/schemas/MetadataMediaType'
        PEGASUS_AUTO_EXPORT_ON_SCAN:
          type: boolean
          title: Pegasus Auto Export On Scan
        CONVERTO:
          $ref: '#/components/schemas/ConvertoConfig'
        CONVERTO_LIBRARY_TARGETS:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Converto Library Targets
      type: object
      required:
      - CONFIG_FILE_MOUNTED
      - CONFIG_FILE_WRITABLE
      - CONFIG_FILE_PARSE_ERROR
      - EXCLUDED_PLATFORMS
      - EXCLUDED_SINGLE_EXT
      - EXCLUDED_SINGLE_FILES
      - EXCLUDED_MULTI_FILES
      - EXCLUDED_MULTI_PARTS_EXT
      - EXCLUDED_MULTI_PARTS_FILES
      - DEFAULT_EXCLUDED_PLATFORM_DIRS
      - DEFAULT_EXCLUDED_MULTI_FILE_DIRS
      - DEFAULT_EXCLUDED_FILES
      - DEFAULT_EXCLUDED_EXTENSIONS
      - PLATFORMS_BINDING
      - PLATFORMS_VERSIONS
      - SKIP_HASH_CALCULATION
      - EJS_DEBUG
      - EJS_CACHE_LIMIT
      - EJS_DISABLE_AUTO_UNLOAD
      - EJS_DISABLE_BATCH_BOOTUP
      - EJS_ENABLE_AUTO_SAVE_SYNC
      - EJS_NETPLAY_ENABLED
      - EJS_NETPLAY_ICE_SERVERS
      - EJS_DEFAULT_CORES
      - EJS_SETTINGS
      - EJS_CONTROLS
      - SCAN_METADATA_PRIORITY
      - SCAN_ARTWORK_PRIORITY
      - SCAN_ARTWORK_PRIORITY_OVERRIDES
      - SCAN_REGION_PRIORITY
      - SCAN_LANGUAGE_PRIORITY
      - SCAN_MEDIA
      - GAMELIST_AUTO_EXPORT_ON_SCAN
      - GAMELIST_MEDIA_THUMBNAIL
      - GAMELIST_MEDIA_IMAGE
      - PEGASUS_AUTO_EXPORT_ON_SCAN
      - CONVERTO
      - CONVERTO_LIBRARY_TARGETS
      title: ConfigResponse
    PlatformBindingPayload:
      properties:
        fs_slug:
          type: string
          title: Fs Slug
        slug:
          type: string
          title: Slug
      type: object
      required:
      - fs_slug
      - slug
      title: PlatformBindingPayload
    ConvertoConfig:
      properties:
        download_conversion_enabled:
          type: boolean
          title: Download Conversion Enabled
          default: false
        scan_metadata:
          type: boolean
          title: Scan Metadata
          default: true
        cache_ttl_hours:
          type: integer
          title: Cache Ttl Hours
          default: 24
        cache_max_size_gb:
          type: integer
          title: Cache Max Size Gb
          default: 20
        platform_formats:
          additionalProperties:
            type: string
          type: object
          title: Platform Formats
      type: object
      title: ConvertoConfig
    ScanSettingsPayload:
      properties:
        metadata_priority:
          items:
            type: string
          type: array
          title: Metadata Priority
        artwork_priority:
          items:
            type: string
          type: array
          title: Artwork Priority
        cover_priority:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Cover Priority
        screenshot_priority:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Screenshot Priority
        manual_priority:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Manual Priority
        region_priority:
          items:
            type: string
          type: array
          title: Region Priority
        language_priority:
          items:
            type: string
          type: array
          title: Language Priority
        media:
          items:
            $ref: '#/components/schemas/MetadataMediaType'
          type: array
          title: Media
        gamelist_export:
          type: boolean
          title: Gamelist Export
        gamelist_thumbnail:
          $ref: '#/components/schemas/MetadataMediaType'
        gamelist_image:
          $ref: '#/components/schemas/MetadataMediaType'
        pegasus_export:
          type: boolean
          title: Pegasus Export
      type: object
      required:
      - metadata_priority
      - artwork_priority
      - region_priority
      - language_priority
      - media
      - gamelist_export
      - gamelist_thumbnail
      - gamelist_image
      - pegasus_export
      title: ScanSettingsPayload
      description: 'Full replacement of the scan.* config section.


        The three artwork override lists (cover/screenshot/manual) are optional:

        a null value clears the override so that field falls back to

        `artwork_priority`.'
    ExclusionPayload:
      properties:
        exclusion_value:
          type: string
          title: Exclusion Value
        exclusion_type:
          type: string
          title: Exclusion Type
      type: object
      required:
      - exclusion_value
      - exclusion_type
      title: ExclusionPayload
    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