This API enables you to create and manage custom endpoints for inbound integrations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/create-your-own-integration"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.1.0
info:
version: 1.0.0
title: Create Your Own Integration API
description: This API enables you to create and manage custom endpoints for inbound integrations.
termsOfService: 'https://www.moogsoft.com/legal-information/express-terms-conditions/'
contact:
name: API Support
url: 'https://docs.moogsoft.com/en/moogsoft-apis.html'
email: support@moogsoft.com
license:
url: 'https://www.moogsoft.com/legal-information'
name: Apex AIOps Incident Management Proprietary
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
paths:
'/v2/integrations/byoapi/{endpointId}/config/draft':
put:
tags:
- custom-integration-configs
summary: Updates the draft config for an endpoint
description: Updates the draft config for an endpoint
operationId: updateDraftEndpointConfig
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
requestBody:
description: The updated config
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointConfigDto'
responses:
'200':
description: Successfully updated draft config
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpointConfigDto'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
get:
tags:
- custom-integration-configs
summary: Gets the draft config for a particular endpoint
description: Gets the unpublished config for an endpoint. This draft is not being applied to payloads sent to the endpoint
operationId: getDraftEndpointConfig
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved the draft config for the endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpointConfigDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
'/v2/integrations/byoapi/{endpointId}/config/live':
put:
tags:
- custom-integration-configs
summary: Updates the live config for an endpoint
description: Updates the live config for an endpoint
operationId: updateLiveEndpointConfig
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
requestBody:
description: The updated config
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointConfigDto'
responses:
'200':
description: Successfully updated live config
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpointConfigDto'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
get:
tags:
- custom-integration-configs
summary: Gets the live config for a particular endpoint
description: Gets the live or published config that an endpoint is currently applying to incoming requests
operationId: getLiveEndpointConfig
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved the live config for the endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpointConfigDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
'/v2/integrations/byoapi/{endpointId}/config/test':
post:
tags:
- custom-integration-configs
summary: Tests the provided config for an endpoint against a provided series of json payloads
description: Tests the provided config for an endpoint against a provided series of json payloads
operationId: testEndpointConfig
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
requestBody:
description: The test config and test payloads
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TestConfigAndPayloads'
responses:
'200':
description: Successfully tested the config
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseTestResult'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
'/v1/integrations/byoapi/{endpointId}/traffic/payloads/{id}':
get:
tags:
- custom-integration-traffic
summary: Get a specific payload sent to an endpoint
description: Gets a recent payload sent to an endpoint by id
operationId: getRecentPayload
parameters:
- name: endpointId
in: path
description: the unique id of the endpoint
required: true
schema:
type: string
- name: id
in: path
description: the unique id of the recent payload
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved recent payload
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseRecentPayload'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
'/v1/integrations/byoapi/{endpointId}/errors':
get:
tags:
- custom-integration-error-logs
summary: Reads custom endpoint processing errors from the DB.
description: 'Reads custom endpoint processing errors from the DB, in reverse chronological order.'
operationId: getProcessingErrors
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfByoErrorLogDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
delete:
tags:
- custom-integration-error-logs
summary: Deletes custom endpoint processing errors from the DB.
description: Deletes custom endpoint processing errors from the DB.
operationId: deleteProcessingErrors
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'204':
description: No Content
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
/v1/integrations/byoapi:
get:
tags:
- custom-integration-endpoints
summary: Get all configured custom endpoints
description: Gets all configured custom endpoints
operationId: getAllEndpoints
parameters:
- name: integration
in: query
schema:
$ref: '#/components/schemas/IntegrationType'
responses:
'200':
description: Successfully retrieved all custom endpoints
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfEndpoint'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
post:
tags:
- custom-integration-endpoints
summary: Create new custom endpoint
description: Create a new custom endpoint
operationId: createCustomEndpoint
requestBody:
description: The config for the new endpoint
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEndpoint'
responses:
'200':
description: Successfully created a new endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpoint'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
'/v1/integrations/byoapi/{endpointId}':
put:
tags:
- custom-integration-endpoints
summary: Update a custom endpoint
description: Updates a configured custom endpoint
operationId: updateCustomEndpoint
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
requestBody:
description: the endpoint config to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BaseEndpointDto'
responses:
'200':
description: Updated endpoint successfully
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpoint'
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
get:
tags:
- custom-integration-endpoints
summary: 'Get a custom endpoint '
description: Gets a custom endpoint by id
operationId: getCustomEndpoint
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Retrieved endpoint successfully
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseEndpoint'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
delete:
tags:
- custom-integration-endpoints
summary: Delete a custom endpoint
description: Deletes a custom endpoint by id
operationId: deleteCustomEndpoint
parameters:
- name: endpointId
in: path
description: The unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Deleted endpoint successfully
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:edit'
'/v1/integrations/byoapi/{endpointId}/traffic/summary':
get:
tags:
- custom-integration-traffic
summary: Get a summary of traffic volume and outcomes for a custom endpoint
description: Returns statistics about traffic to a given endpoint
operationId: getTrafficSummary
parameters:
- name: endpointId
in: path
description: the unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved endpoint summary
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseTrafficSummaryDto'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
/v1/integrations/byoapi-integrations:
get:
tags:
- byoapi-integration-endpoints
summary: Get all configured integrations endpoints
description: Gets all configured integrations endpoints
operationId: getAllIntegrations
responses:
'200':
description: Successfully retrieved all custom endpoints
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfEndpoint'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'integrations:view'
'/v1/integrations/custom/{integrationId}':
post:
tags:
- custom-integration-endpoints
summary: Post payload to a custom endpoint
description: Post a payload to a user defined endpoint
operationId: postPayloadOnIntegrationId
parameters:
- name: x-forward-for
in: header
schema: {}
- name: integrationId
in: path
description: The id of the integration
required: true
schema:
type: string
requestBody:
description: User json/xml
required: true
content:
'application/json, application/xml':
schema:
type: object
responses:
'200':
description: Successfully processed Json
content:
application/json:
schema: {}
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value: []
'/v1/integrations/custom/{uuid}/{endpointName}':
post:
tags:
- custom-integration-endpoints
summary: Post urlencoded form-data payload to a custom endpoint
description: Post a urlencoded form-data payload to a user defined endpoint
operationId: postFormPayload
parameters:
- name: x-forward-for
in: header
schema: {}
- name: endpointName
in: path
description: The name of the endpoint
required: true
schema:
type: string
- name: uuid
in: path
description: The unique id generated for your Moogsoft instance
required: true
schema:
type: string
requestBody:
description: 'User url-encoded form data, containing form parameter "paylod"'
required: true
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
properties:
payload:
type: string
required:
- payload
responses:
'200':
description: Successfully processed url-encoded form
content:
application/json:
schema: {}
'400':
description: Bad Request
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value: []
'/v1/integrations/byoapi/{endpointId}/traffic/payloads':
get:
tags:
- custom-integration-traffic
summary: Get recent payloads sent to an endpoint
description: 'Gets recent payloads sent to an endpoint. Typically, the most recent 1,000 payloads are retained, but that limit may vary subject to system configuration.'
operationId: getAllRecentPayloads
parameters:
- name: maxResults
in: query
description: the max number of recent payloads to return
required: true
schema:
type: integer
format: int32
default: 10
- name: endpointId
in: path
description: the unique id of the endpoint
required: true
schema:
type: string
responses:
'200':
description: Successfully retrieved recent payloads
content:
application/json:
schema:
$ref: '#/components/schemas/MoogResponseListOfRecentPayload'
'400':
description: Invalid parameters or data validation violation
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
'404':
description: Requested object(s) not found
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
4XX:
description: Authorization or other error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogFailureResponse'
5XX:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/MoogErrorResponse'
security:
- ApiKeyAuth: []
servers:
- url: 'https://api.moogsoft.ai'
- url: 'https://api.dev.moogsoft.cloud'
x-permissions:
description: Required user permissions for this endpoint
value:
- 'in
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/moogsoft/refs/heads/main/openapi/moogsoft-byo-api-service-openapi.yaml