Adaptris /adapter API
The /adapter API from Adaptris — 12 operation(s) for /adapter.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/adaptris:adaptris-adapter-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Interlok UI Api Documentation /adapter API
description: Interlok UI Api web service documentation.
version: 3.10.2-RELEASE
servers:
- url: /interlok/api
tags:
- name: /adapter
paths:
/external/adapter/{url}/{jmxUid}:
get:
tags:
- /adapter
description: Get an adapter
operationId: get
parameters:
- name: url
in: path
required: true
schema:
type: string
- name: jmxUid
in: path
description: The unique identifier used in the Adapter configuration XML.
required: true
schema:
type: string
- name: Jmx-Credentials
in: header
description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
schema:
type: string
- name: jmxEnv
in: query
description: The JMX environment parameters used to connect to an Adapter.
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/AdapterEntity'
application/xml:
schema:
$ref: '#/components/schemas/AdapterEntity'
summary: Get
x-summary-source: derived
/external/adapter/{adapter}:
get:
tags:
- /adapter
description: Get an adapter
operationId: get_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:
$ref: '#/components/schemas/AdapterEntity'
application/xml:
schema:
$ref: '#/components/schemas/AdapterEntity'
summary: Get 1
x-summary-source: derived
delete:
tags:
- /adapter
description: Delete an adapter
operationId: delete
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:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Delete
x-summary-source: derived
/external/adapter:
get:
tags:
- /adapter
description: List all register adapters in the Interlok UI
operationId: list
parameters:
- name: pageSize
in: query
schema:
type: integer
format: int32
default: -1
- name: page
in: query
schema:
type: integer
format: int32
default: -1
responses:
default:
description: default response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
summary: List
x-summary-source: derived
post:
tags:
- /adapter
description: Add an adapter in the Interlok UI
operationId: save_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
application/xml:
schema:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
application/xml:
schema:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
summary: Save 1
x-summary-source: derived
/external/adapter/{adapter}/state:
get:
tags:
- /adapter
description: Get an adapter's state
operationId: getState
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:
$ref: '#/components/schemas/StateWrapper'
application/xml:
schema:
$ref: '#/components/schemas/StateWrapper'
summary: Get state
x-summary-source: derived
put:
tags:
- /adapter
description: Update an adapter's state
operationId: updateState_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
- name: adpMgmtTimeout
in: query
description: The max timeout to wait for in milliseconds
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 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/state:
get:
tags:
- /adapter
description: Get an adapter's state
operationId: getState_1
parameters:
- name: url
in: path
required: true
schema:
type: string
- name: jmxUid
in: path
description: The unique identifier used in the Adapter configuration XML.
required: true
schema:
type: string
- name: Jmx-Credentials
in: header
description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
schema:
type: string
- name: jmxEnv
in: query
description: The JMX environment parameters used to connect to an Adapter.
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 1
x-summary-source: derived
put:
tags:
- /adapter
description: Update an adapter's state
operationId: updateState
parameters:
- name: url
in: path
required: true
schema:
type: string
- name: jmxUid
in: path
description: The unique identifier used in the Adapter configuration XML.
required: true
schema:
type: string
- name: Jmx-Credentials
in: header
description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
schema:
type: string
- name: jmxEnv
in: query
description: The JMX environment parameters used to connect to an Adapter.
schema:
type: string
- name: adpMgmtTimeout
in: query
description: The max timeout to wait for in milliseconds
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
x-summary-source: derived
/external/adapter/batch:
post:
tags:
- /adapter
description: Add multiple adapters in the Interlok UI
operationId: save
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
responses:
default:
description: default response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/AdapterJmxInterlokDetails'
summary: Save
x-summary-source: derived
/external/adapter/{adapter}/configuration:
get:
tags:
- /adapter
description: Get an adapter's configuration
operationId: configuration
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: object
additionalProperties:
type: object
summary: Configuration
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/configuration:
get:
tags:
- /adapter
description: Get an adapter's configuration
operationId: configuration_1
parameters:
- name: url
in: path
required: true
schema:
type: string
- name: jmxUid
in: path
description: The unique identifier used in the Adapter configuration XML.
required: true
schema:
type: string
- name: Jmx-Credentials
in: header
description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
schema:
type: string
- name: jmxEnv
in: query
description: The JMX environment parameters used to connect to an Adapter.
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
type: object
additionalProperties:
type: object
summary: Configuration 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/details:
get:
tags:
- /adapter
description: Get details for an adapter
operationId: details
parameters:
- name: url
in: path
required: true
schema:
type: string
- name: jmxUid
in: path
description: The unique identifier used in the Adapter configuration XML.
required: true
schema:
type: string
- name: Jmx-Credentials
in: header
description: The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.
schema:
type: string
- name: jmxEnv
in: query
description: The JMX environment parameters used to connect to an Adapter.
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
x-summary-source: derived
/external/adapter/{adapter}/details:
get:
tags:
- /adapter
description: Get details for an adapter
operationId: details_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:
$ref: '#/components/schemas/ComponentDetails'
application/xml:
schema:
$ref: '#/components/schemas/ComponentDetails'
summary: Details 1
x-summary-source: derived
/external/adapter/{adapter}/name:
put:
tags:
- /adapter
description: Update an adapter's name
operationId: updateName
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
requestBody:
content:
text/plain:
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Update name
x-summary-source: derived
/external/adapter/{adapter}/tags:
put:
tags:
- /adapter
description: Update an adapter's tags
operationId: updateTags
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
requestBody:
content:
text/plain:
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Update tags
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
AdapterEntity:
required:
- jmxUid
- name
- url
type: object
properties:
id:
type: integer
format: int32
created:
type: string
format: date-time
updated:
type: string
format: date-time
name:
maxLength: 127
minLength: 1
type: string
jmxUid:
maxLength: 127
minLength: 1
type: string
tags:
maxLength: 512
minLength: 0
type: string
url:
maxLength: 255
minLength: 1
pattern: (service:jmx:)(.*)(://)(.*)
type: string
jmxUsername:
maxLength: 255
minLength: 0
type: string
jmxPassword:
maxLength: 255
minLength: 0
type: string
jmxEnv:
maxLength: 512
minLength: 0
type: string
configLastUpdated:
type: string
format: date-time
ordering:
type: integer
format: int32
autoDiscovered:
type: boolean
state:
type: string
enum:
- CLOSED
- INITIALISED
- STARTED
- STOPPED
- DISCONNECTED
configFileUrl:
type: string
channels:
type: array
items:
$ref: '#/components/schemas/ChannelEntity'
type:
type: string
xml:
name: adapter
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
AdapterJmxInterlokDetails:
type: object
properties:
jmxUid:
type: string
url:
type: string
jmxUsername:
type: string
jmxPassword:
type: string
jmxEnv:
type: string
id:
type: integer
format: int32
name:
type: string
tags:
type: string
xml:
name: adapter
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