Roku asyncapi API

openapi: 3.0.3
info:
  title: Roku External Control Protocol (ECP) Apps asyncapi API
  version: '1.0'
  description: 'The External Control Protocol (ECP) is an HTTP-based API exposed on port 8060 of every Roku

    streaming device on the local network. It enables third-party applications, mobile remote-control

    apps, automated testing systems, and home-automation hubs to discover Roku devices via SSDP,

    inject simulated remote-control key presses, launch installed apps with deep-link parameters,

    query device state, and retrieve diagnostic information.


    The protocol is plain HTTP/1.1 (no TLS) and is intended for trusted local-network use only.

    Most control operations require the user to enable "Control by mobile apps" on the device.

    Additional diagnostic endpoints (chanperf, sgnodes, registry, etc.) are gated behind Roku

    Developer Mode.

    '
  contact:
    name: Roku Developer Program
    url: https://developer.roku.com
  x-generated-from: documentation
  x-source-url: https://developer.roku.com/docs/developer-program/dev-tools/external-control-api.md
servers:
- url: http://{rokuDeviceIp}:8060
  description: A Roku device on the local network
  variables:
    rokuDeviceIp:
      default: 192.168.1.100
      description: The IPv4 address of the Roku device, discovered via SSDP
tags:
- name: asyncapi
paths:
  /asyncapi:
    get:
      tags:
      - asyncapi
      summary: Roku Serve Asyncapi Schema
      description: Serve the AsyncAPI schema as an HTML response.
      operationId: asyncapi-serve_asyncapi_schema
      parameters:
      - name: sidebar
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Sidebar
      - name: info
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Info
      - name: servers
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Servers
      - name: operations
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Operations
      - name: messages
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Messages
      - name: schemas
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Schemas
      - name: errors
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Errors
      - name: expandMessageExamples
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Expandmessageexamples
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /asyncapi.json:
    get:
      tags:
      - asyncapi
      summary: Roku Download App Json Schema
      operationId: asyncapi-download_app_json_schema
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /asyncapi.yaml:
    get:
      tags:
      - asyncapi
      summary: Roku Download App Yaml Schema
      operationId: asyncapi-download_app_yaml_schema
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError