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/prowlarr:prowlarr-system-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: Prowlarr System API
  description: Prowlarr API docs
  license:
    name: GPL-3.0
    url: https://github.com/Prowlarr/Prowlarr/blob/develop/LICENSE
  version: 1.0.0
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:9696
security:
- X-Api-Key: []
- apikey: []
tags:
- name: System
paths:
  /api/v1/system/status:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemResource'
      summary: Get api system status
      x-summary-source: derived
      operationId: getApiV1SystemStatus
      x-operation-id-source: derived
  /api/v1/system/routes:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Get api system routes
      x-summary-source: derived
      operationId: getApiV1SystemRoutes
      x-operation-id-source: derived
  /api/v1/system/routes/duplicate:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Get api system routes duplicate
      x-summary-source: derived
      operationId: getApiV1SystemRoutesDuplicate
      x-operation-id-source: derived
  /api/v1/system/shutdown:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Create api system shutdown
      x-summary-source: derived
      operationId: postApiV1SystemShutdown
      x-operation-id-source: derived
  /api/v1/system/restart:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Create api system restart
      x-summary-source: derived
      operationId: postApiV1SystemRestart
      x-operation-id-source: derived
components:
  schemas:
    UpdateMechanism:
      enum:
      - builtIn
      - script
      - external
      - apt
      - docker
      type: string
    SystemResource:
      type: object
      properties:
        appName:
          type:
          - string
          - 'null'
        instanceName:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        buildTime:
          type: string
          format: date-time
        isDebug:
          type: boolean
        isProduction:
          type: boolean
        isAdmin:
          type: boolean
        isUserInteractive:
          type: boolean
        startupPath:
          type:
          - string
          - 'null'
        appData:
          type:
          - string
          - 'null'
        osName:
          type:
          - string
          - 'null'
        osVersion:
          type:
          - string
          - 'null'
        isNetCore:
          type: boolean
        isLinux:
          type: boolean
        isOsx:
          type: boolean
        isWindows:
          type: boolean
        isDocker:
          type: boolean
        mode:
          $ref: '#/components/schemas/RuntimeMode'
        branch:
          type:
          - string
          - 'null'
        databaseType:
          $ref: '#/components/schemas/DatabaseType'
        databaseVersion:
          type:
          - string
          - 'null'
        authentication:
          $ref: '#/components/schemas/AuthenticationType'
        migrationVersion:
          type: integer
          format: int32
        urlBase:
          type:
          - string
          - 'null'
        runtimeVersion:
          type:
          - string
          - 'null'
        runtimeName:
          type:
          - string
          - 'null'
        startTime:
          type: string
          format: date-time
        packageVersion:
          type:
          - string
          - 'null'
        packageAuthor:
          type:
          - string
          - 'null'
        packageUpdateMechanism:
          $ref: '#/components/schemas/UpdateMechanism'
        packageUpdateMechanismMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    RuntimeMode:
      enum:
      - console
      - service
      - tray
      type: string
    AuthenticationType:
      enum:
      - none
      - basic
      - forms
      - external
      type: string
    DatabaseType:
      enum:
      - sqLite
      - postgreSQL
      type: string
  securitySchemes:
    X-Api-Key:
      type: apiKey
      description: Apikey passed as header
      name: X-Api-Key
      in: header
    apikey:
      type: apiKey
      description: Apikey passed as query parameter
      name: apikey
      in: query