Adaptris /adapter/failed Messages API
The /adapter/failed-messages API from Adaptris — 12 operation(s) for /adapter/failed-messages.
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-failed-messages-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/failed Messages API
description: Interlok UI Api web service documentation.
version: 3.10.2-RELEASE
servers:
- url: /interlok/api
tags:
- name: /adapter/failed-messages
paths:
/external/adapter/{adapter}/failed-messages/count:
get:
tags:
- /adapter/failed-messages
description: Get the number of failed messages for an adapter
operationId: failedMessagesCount
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/Count'
application/xml:
schema:
$ref: '#/components/schemas/Count'
summary: Failed messages count
x-summary-source: derived
/external/adapter/{adapter}/failed-messages/ignore:
put:
tags:
- /adapter/failed-messages
description: Ignore an adapter failed message
operationId: ignoreFailedMessage
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: deleteMsgFile
in: query
description: Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
application/xml:
schema:
type: array
items:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Ignore failed message
x-summary-source: derived
post:
tags:
- /adapter/failed-messages
description: Ignore all the adapter failed message
operationId: ignoreAllFailedMessage
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: deleteMsgFile
in: query
description: Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Ignore all failed message
x-summary-source: derived
/external/adapter/{adapter}/failed-messages/total-count:
get:
tags:
- /adapter/failed-messages
description: Get an adapter total failed messages count since started
operationId: totalFailedMessagesCount
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/Count'
application/xml:
schema:
$ref: '#/components/schemas/Count'
summary: Total failed messages count
x-summary-source: derived
/external/adapter/{adapter}/failed-messages/retry:
put:
tags:
- /adapter/failed-messages
description: Retry an adapter failed message
operationId: retryFailedMessage
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:
application/json:
schema:
type: array
items:
type: string
application/xml:
schema:
type: array
items:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Retry failed message
x-summary-source: derived
post:
tags:
- /adapter/failed-messages
description: Retry all the adapter failed messages
operationId: retryAllFailedMessage
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: Retry all failed message
x-summary-source: derived
/external/adapter/{adapter}/failed-messages/last-hundred:
get:
tags:
- /adapter/failed-messages
description: Get all the failed messages for an adapter
operationId: lastHundredFailedMessages
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/FailedMessageEntity'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
summary: Last hundred failed messages
x-summary-source: derived
/external/adapter/{adapter}/failed-messages:
get:
tags:
- /adapter/failed-messages
description: Get all the failed messages for an adapter
operationId: failedMessages
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: from
in: query
schema:
type: integer
format: int32
default: 0
- name: to
in: query
schema:
type: integer
format: int32
default: 100
responses:
default:
description: default response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
summary: Failed messages
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages/count:
get:
tags:
- /adapter/failed-messages
description: Get the number of failed messages for an adapter
operationId: failedMessagesCount_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/Count'
application/xml:
schema:
$ref: '#/components/schemas/Count'
summary: Failed messages count 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages/ignore:
put:
tags:
- /adapter/failed-messages
description: Ignore an adapter failed message
operationId: ignoreFailedMessage_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
- name: deleteMsgFile
in: query
description: Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
application/xml:
schema:
type: array
items:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Ignore failed message 1
x-summary-source: derived
post:
tags:
- /adapter/failed-messages
description: Ignore all the adapter failed message
operationId: ignoreAllFailedMessage_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
- name: deleteMsgFile
in: query
description: Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.
schema:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Ignore all failed message 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages/total-count:
get:
tags:
- /adapter/failed-messages
description: Get an adapter total failed messages count since started
operationId: totalFailedMessagesCount_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/Count'
application/xml:
schema:
$ref: '#/components/schemas/Count'
summary: Total failed messages count 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages/retry:
put:
tags:
- /adapter/failed-messages
description: Retry an adapter failed message
operationId: retryFailedMessage_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
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
application/xml:
schema:
type: array
items:
type: string
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Retry failed message 1
x-summary-source: derived
post:
tags:
- /adapter/failed-messages
description: Retry all the adapter failed messages
operationId: retryAllFailedMessage_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/Result'
application/xml:
schema:
$ref: '#/components/schemas/Result'
summary: Retry all failed message 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages/last-hundred:
get:
tags:
- /adapter/failed-messages
description: Get all the failed messages for an adapter
operationId: lastHundredFailedMessages_1
parameters:
- name: url
in: path
description: The JMX URL used to connect to an Adapter.
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: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
summary: Last hundred failed messages 1
x-summary-source: derived
/external/adapter/{url}/{jmxUid}/failed-messages:
get:
tags:
- /adapter/failed-messages
description: Get all the failed messages for an adapter
operationId: failedMessages_1
parameters:
- name: url
in: path
description: The JMX URL used to connect to an Adapter.
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: from
in: query
schema:
type: integer
format: int32
default: 0
- name: to
in: query
schema:
type: integer
format: int32
default: 100
responses:
default:
description: default response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/FailedMessageEntity'
summary: Failed messages 1
x-summary-source: derived
components:
schemas:
FailedMessageEntity:
type: object
properties:
id:
type: string
payload:
type: string
payloadEncoding:
type: string
nextServiceId:
type: string
metadata:
type: object
additionalProperties:
type: string
workflowId:
type: string
date:
type: string
format: date-time
fileSystemPath:
type: string
stackTrace:
type: string
error:
type: string
canRetry:
type: boolean
xml:
name: failed-message
Result:
type: object
properties:
id:
type: string
value:
type: boolean
message:
type: string
state:
type: string
stackTrace:
type: string
Count:
type: object
properties:
value:
type: integer
format: int32