Custom Integration API Endpoint Object

Schema used for creating, retrieving, and updating Custom Integration endpoints

{
  "authRequired": true,
  "description": "Brew APM events",
  "draftConfigV2": {
    "batchKey": "",
    "mappings": [...]
  },
  "endpointName": "brewapm",
  "endpointUrl": "https://api.moogsoft.com/v1/integrations/custom/416bff3febf7cc/brewapm",
  "id": "cf5a54a6bc23042eee453a89",
  "status": "PROVISIONED",
  "type": "EVENT"
}

description

string

User-defined endpoint description.

draftConfigV2

string

The config object that defines the mappings for this endpoint. See See Custom Integration API Mapping Config Object.

endpointName

string

The user-specified endpoint name. The last part of the endpoint URL is /.

endpointUrl

string

The full URL for the endpoint.

id

string

Auto-generated ID of the endpoint.

status

enumerated string

The current endpoint status. Can be "PROVISIONED" or "RUNNING".

type

enumerated string

The type of object the endpoint is configured to ingest. Can be "EVENT" or "METRIC".