How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Moogsoft Create Your Own Integration API

This API enables you to create and manage custom endpoints for inbound integrations.

Moogsoft Create Your Own Integration API is one of 17 APIs that Moogsoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AIOps, Incident Management, byoapi-integration-endpoints, custom-integration-configs, and custom-integration-endpoints. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 18 operations across 12 paths, organized into 5 resource areas, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.moogsoft.ai, https://api.dev.moogsoft.cloud.

18 operations 12 paths 31 schemas 2 DELETE9 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.moogsoft.ai
Authentication
API Key
Terms of Service
Resource Areas
5

Authentication & Security 1

Moogsoft Create Your Own Integration API declares 1 security scheme for authenticating requests. An API key is passed in the header as apiKey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API Key for accessing Create Your Own Integration API

Paths & Operations 18

Across 12 paths, the API surfaces 18 operations — 2 DELETE, 9 GET, 4 POST, 3 PUT. They span 5 resource areas: custom-integration-configs, custom-integration-traffic, custom-integration-error-logs, custom-integration-endpoints, byoapi-integration-endpoints. Each is listed below with its method, path, parameters, and response codes.

custom-integration-configs 5

Operations for custom integration configs

PUT
/v2/integrations/byoapi/{endpointId}/config/draft
Updates the draft config for an endpoint
updateDraftEndpointConfig 1 param body → 2004004044XX5XX
GET
/v2/integrations/byoapi/{endpointId}/config/draft
Gets the draft config for a particular endpoint
getDraftEndpointConfig 1 param → 2004004044XX5XX
PUT
/v2/integrations/byoapi/{endpointId}/config/live
Updates the live config for an endpoint
updateLiveEndpointConfig 1 param body → 2004004044XX5XX
GET
/v2/integrations/byoapi/{endpointId}/config/live
Gets the live config for a particular endpoint
getLiveEndpointConfig 1 param → 2004004044XX5XX
POST
/v2/integrations/byoapi/{endpointId}/config/test
Tests the provided config for an endpoint against a provided series of json payloads
testEndpointConfig 1 param body → 2004004044XX5XX
custom-integration-traffic 3

Operations for custom integration traffic

GET
/v1/integrations/byoapi/{endpointId}/traffic/payloads/{id}
Get a specific payload sent to an endpoint
getRecentPayload 2 params → 2004004044XX5XX
GET
/v1/integrations/byoapi/{endpointId}/traffic/summary
Get a summary of traffic volume and outcomes for a custom endpoint
getTrafficSummary 1 param → 2004004044XX5XX
GET
/v1/integrations/byoapi/{endpointId}/traffic/payloads
Get recent payloads sent to an endpoint
getAllRecentPayloads 2 params → 2004004044XX5XX
custom-integration-error-logs 2

Operations for custom integration error logs

GET
/v1/integrations/byoapi/{endpointId}/errors
Reads custom endpoint processing errors from the DB.
getProcessingErrors 1 param → 2004004044XX5XX
DELETE
/v1/integrations/byoapi/{endpointId}/errors
Deletes custom endpoint processing errors from the DB.
deleteProcessingErrors 1 param → 2044004044XX5XX
custom-integration-endpoints 7

Operations for custom integration endpoints

GET
/v1/integrations/byoapi
Get all configured custom endpoints
getAllEndpoints 1 param → 2004004044XX5XX
POST
/v1/integrations/byoapi
Create new custom endpoint
createCustomEndpoint body → 2004004044XX5XX
PUT
/v1/integrations/byoapi/{endpointId}
Update a custom endpoint
updateCustomEndpoint 1 param body → 2004004044XX5XX
GET
/v1/integrations/byoapi/{endpointId}
Get a custom endpoint
getCustomEndpoint 1 param → 2004004044XX5XX
DELETE
/v1/integrations/byoapi/{endpointId}
Delete a custom endpoint
deleteCustomEndpoint 1 param → 2004004044XX5XX
POST
/v1/integrations/custom/{integrationId}
Post payload to a custom endpoint
postPayloadOnIntegrationId 2 params body → 2004004044XX5XX
POST
/v1/integrations/custom/{uuid}/{endpointName}
Post urlencoded form-data payload to a custom endpoint
postFormPayload 3 params body → 2004004044XX5XX
byoapi-integration-endpoints 1
GET
/v1/integrations/byoapi-integrations
Get all configured integrations endpoints
getAllIntegrations → 2004004044XX5XX

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are WebEventDto (17 properties), LocationDto (17 properties), Endpoint (14 properties), RecentPayload (8 properties). Each schema is shown below with its type and property counts.

EndpointConfigDto
object
Create your own endpoint configuration.
2 properties 1 required
Mapping
object
MoogResponseEndpointConfigDto
object
Create Your Own Integration API EndpointConfigDto response body
2 properties 2 required
MoogFailureResponse
object
Create Your Own Integration API failure response body
3 properties 2 required
MoogErrorResponse
object
Create Your Own Integration API error response body
3 properties 2 required
TestConfigAndPayloads
object
The test config and json payloads required to run a test
2 properties 2 required
MoogResponseTestResult
object
Create Your Own Integration API TestResult response body
2 properties 2 required
TestResult
object
The results of testing an endpoint config
2 properties
TestMappingResultDto
object
5 properties
WebEventDto
object
17 properties 4 required
Severity
string
Severity Level (case-insensitive)
Timestamp
integer
Number of milliseconds since Jan 1, 1970 UTC
LocationDto
object
17 properties
GeoLocationDto
object
2 properties
DedupeKeyStatus
string
MoogResponseRecentPayload
object
Create Your Own Integration API RecentPayload response body
2 properties 2 required
RecentPayload
object
Recent payloads recieved by an endpoint
8 properties
MoogResponseListOfByoErrorLogDto
object
Create Your Own Integration API ByoErrorLogDto response body
2 properties 2 required
ByoErrorLogDto
object
4 properties
Instant
number
IntegrationType
string
MoogResponseListOfEndpoint
object
Create Your Own Integration API Endpoint response body
2 properties 2 required
Endpoint
object
A configured endpoint
14 properties 2 required
EndpointStatus
string
Type
string
CreateEndpoint
object
Information required to create an endpoint
4 properties 2 required
MoogResponseEndpoint
object
Create Your Own Integration API Endpoint response body
2 properties 2 required
BaseEndpointDto
object
3 properties 2 required
MoogResponseTrafficSummaryDto
object
Create Your Own Integration API TrafficSummaryDto response body
2 properties 2 required
TrafficSummaryDto
object
Traffic summary.
2 properties
MoogResponseListOfRecentPayload
object
Create Your Own Integration API RecentPayload response body
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

moogsoft-byo-api-service-openapi.yaml Raw ↑

Other APIs Moogsoft publishes across the network.

Moogsoft Alerts/Incidents API
Moogsoft Azure Application Insights API
Moogsoft Amazon CloudWatch API
Moogsoft Collector V2 API
Moogsoft Config API
Moogsoft Events Integration API
Moogsoft On-Call API
Moogsoft Rollup Service API
Moogsoft Metrics API
Moogsoft PagerDuty Integration API
Moogsoft Probable Root Cause API
Moogsoft Similar Incidents API
Where this information came from

This is an independent, third-party profile of Moogsoft Create Your Own Integration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.