Adaptris

Adaptris /channel API

The /channel API from Adaptris — 12 operation(s) for /channel.

GitHub OpenAPI

Operations 14

GET /external/adapter/{adapter}/channel/{channel} Get 2 #
GET /external/adapter/{adapter}/channel/count Count #
GET /external/adapter/{adapter}/channel List 1 #
GET /external/adapter/{adapter}/channel/{channel}/state Get state 2 #
PUT /external/adapter/{adapter}/channel/{channel}/state Update state 2 #
GET /external/adapter/{adapter}/channel/{channel}/configuration Configuration 2 #
GET /external/adapter/{adapter}/channel/{channel}/details Details 2 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel} Get 3 #
GET /external/adapter/{url}/{jmxUid}/channel/count Count 1 #
GET /external/adapter/{url}/{jmxUid}/channel List 2 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/state Get state 3 #
PUT /external/adapter/{url}/{jmxUid}/channel/{channel}/state Update state 3 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/configuration Configuration 3 #
GET /external/adapter/{url}/{jmxUid}/channel/{channel}/details Details 3 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/openapi/adaptris-channel-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-adapter-jmx-interlok-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-component-check-wrapper-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/adaptris/refs/heads/main/json-schema/adaptris-state-wrapper-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/adaptris:adaptris-channel-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

adaptris-channel-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Interlok UI Api Documentation /channel API
  description: Interlok UI Api web service documentation.
  version: 3.10.2-RELEASE
servers:
- url: /interlok/api
tags:
- name: /channel
paths:
  /external/adapter/{adapter}/channel/{channel}:
    get:
      tags:
      - /channel
      description: Get a channel for an adapter
      operationId: get_2
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/ChannelEntity'
      summary: Get 2
      x-summary-source: derived
  /external/adapter/{adapter}/channel/count:
    get:
      tags:
      - /channel
      description: Counts channels for an adapter
      operationId: count
      parameters:
      - name: adapter
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Count'
            application/xml:
              schema:
                $ref: '#/components/schemas/Count'
      summary: Count
      x-summary-source: derived
  /external/adapter/{adapter}/channel:
    get:
      tags:
      - /channel
      description: Lists channels for an adapter
      operationId: list_1
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChannelEntity'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChannelEntity'
      summary: List 1
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/state:
    get:
      tags:
      - /channel
      description: Get a channel's state
      operationId: getState_2
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateWrapper'
            application/xml:
              schema:
                $ref: '#/components/schemas/StateWrapper'
      summary: Get state 2
      x-summary-source: derived
    put:
      tags:
      - /channel
      description: Update a channel's state
      operationId: updateState_2
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
      - name: adpMgmtTimeout
        in: query
        description: adpMgmtTimeout
        schema:
          type: string
      - name: option
        in: query
        schema:
          type: string
          enum:
          - FORCE_CLOSE
          - FORCE_CLOSE_IF_FAIL
          - RESTART
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StateWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/StateWrapper'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Update state 2
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/configuration:
    get:
      tags:
      - /channel
      description: Get a channel's configuration
      operationId: configuration_2
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
      summary: Configuration 2
      x-summary-source: derived
  /external/adapter/{adapter}/channel/{channel}/details:
    get:
      tags:
      - /channel
      description: Get details for a channel
      operationId: details_2
      parameters:
      - name: adapter
        in: path
        description: The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.
        required: true
        schema:
          type: string
      - name: channel
        in: path
        description: The channel unique id.
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
      summary: Details 2
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}:
    get:
      tags:
      - /channel
      operationId: get_3
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      - name: channel
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/ChannelEntity'
      summary: Get 3
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/count:
    get:
      tags:
      - /channel
      operationId: count_1
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Count'
            application/xml:
              schema:
                $ref: '#/components/schemas/Count'
      summary: Count 1
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel:
    get:
      tags:
      - /channel
      operationId: list_2
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChannelEntity'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChannelEntity'
      summary: List 2
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/state:
    get:
      tags:
      - /channel
      operationId: getState_3
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      - name: channel
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StateWrapper'
            application/xml:
              schema:
                $ref: '#/components/schemas/StateWrapper'
      summary: Get state 3
      x-summary-source: derived
    put:
      tags:
      - /channel
      operationId: updateState_3
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      - name: channel
        in: path
        required: true
        schema:
          type: string
      - name: adpMgmtTimeout
        in: query
        schema:
          type: string
      - name: option
        in: query
        schema:
          type: string
          enum:
          - FORCE_CLOSE
          - FORCE_CLOSE_IF_FAIL
          - RESTART
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StateWrapper'
          application/xml:
            schema:
              $ref: '#/components/schemas/StateWrapper'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
      summary: Update state 3
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/configuration:
    get:
      tags:
      - /channel
      operationId: configuration_3
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      - name: channel
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
      summary: Configuration 3
      x-summary-source: derived
  /external/adapter/{url}/{jmxUid}/channel/{channel}/details:
    get:
      tags:
      - /channel
      operationId: details_3
      parameters:
      - name: url
        in: path
        required: true
        schema:
          type: string
      - name: jmxUid
        in: path
        required: true
        schema:
          type: string
      - name: Jmx-Credentials
        in: header
        schema:
          type: string
      - name: jmxEnv
        in: query
        schema:
          type: string
      - name: channel
        in: path
        required: true
        schema:
          type: string
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/ComponentDetails'
      summary: Details 3
      x-summary-source: derived
components:
  schemas:
    WorkflowEntity:
      type: object
      properties:
        name:
          type: string
        lifeCycleActionsDisabled:
          type: boolean
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
        type:
          type: string
        id:
          type: string
      xml:
        name: workflow
    Count:
      type: object
      properties:
        value:
          type: integer
          format: int32
    StateWrapper:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
      xml:
        name: state-wrapper
    Result:
      type: object
      properties:
        id:
          type: string
        value:
          type: boolean
        message:
          type: string
        state:
          type: string
        stackTrace:
          type: string
    ChannelEntity:
      type: object
      properties:
        name:
          type: string
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
        workflows:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowEntity'
        type:
          type: string
        id:
          type: string
      xml:
        name: channel
    ComponentDetails:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - CLOSED
          - INITIALISED
          - STARTED
          - STOPPED
          - DISCONNECTED
        lastStarted:
          type: string
          format: date-time
        lastStopped:
          type: string
          format: date-time
        inFlight:
          type: integer
          format: int32
        uptime:
          type: string
        downtime:
          type: string
      xml:
        name: component-details