Contrail HealthBot LFA API

Copyright 2017-2019, Juniper Networks, Inc. All rights reserved.
LFA API interface for HealthBot application
More information: Contrail HealthBot
Version: 1.2.5

Access

Methods

[ Jump to Models ]

Table of Contents

Events

Feeds

Hosts

Profiles

Rulegroups

Spans

Events

Up
put /api/event/{event}/clear
Clear event (eventClear)
Clear event.

Path parameters

event (required)
Path Parameter — Name of event. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/event_config
Get event configuration (eventConfigGet)
Get event configuration.

Return type

response_event_config_value

Example data

Content-Type: application/json
{
  "result" : {
    "webhookproxy" : "webhookproxy",
    "smtp" : "smtp",
    "email" : "email",
    "webhookurl" : "webhookurl"
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_event_config_value

Up
post /api/event_config
Edit event configuration (eventConfigSet)
Edit event configuration.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

event_config_value event_config_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
delete /api/event/{event}
Delete event (eventDelete)
Delete event.

Path parameters

event (required)
Path Parameter — Name of event. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/event/{event}
Get event details (eventGet)
Get event details.

Path parameters

event (required)
Path Parameter — Name of event. default: null

Return type

response_event_value

Example data

Content-Type: application/json
{
  "result" : {
    "record" : "{}",
    "active" : true,
    "posted" : 0
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_event_value

Up
put /api/events/clear
Clear ALL events (eventsClear)
Clear ALL events

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
delete /api/events
Delete ALL events (eventsDelete)
Delete ALL events.

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/events
List events (eventsGet)
List events.

Return type

response_event_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_event_list

Up
get /api/events/active
List active events (eventsGetActive)
List active events.

Return type

response_event_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_event_list

Feeds

Up
delete /api/feed/{feed}
Delete feed (feedDelete)
Delete feed.

Path parameters

feed (required)
Path Parameter — Name of feed default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/feed/{feed}
Get feed details (feedGet)
Get feed details.

Path parameters

feed (required)
Path Parameter — Name of feed. default: null

Return type

response_feed_value

Example data

Content-Type: application/json
{
  "result" : {
    "kafka_servers" : "kafka_servers",
    "kafka_offset" : "kafka_offset",
    "notes" : "notes",
    "kafka_partition" : "kafka_partition",
    "syslog_server" : "syslog_server",
    "kafka_topic" : "kafka_topic",
    "type" : "kafka"
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_feed_value

Up
post /api/feed/{feed}
Add/edit feed details (feedSet)
Add/edit feed details.

Path parameters

feed (required)
Path Parameter — Name of feed. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

feed_value feed_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/feeds
List feeds (feedsGet)
List feeds.

Return type

response_feed_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_feed_list

Hosts

Up
delete /api/host/{host}
Delete host (hostDelete)
Delete host.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
put /api/host/{host}/disable
Disable host automatic push (hostDisable)
Disable host automatic push.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
put /api/host/{host}/enable
Enable host automatic push (hostEnable)
Enable host automatic push.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/host/{host}
Get host details (hostGet)
Get host details.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_host_value

Example data

Content-Type: application/json
{
  "result" : {
    "hostname" : "hostname",
    "password" : "password",
    "timezone" : "timezone",
    "profile" : "profile",
    "updated" : 6,
    "retention" : 2,
    "levels" : [ {
      "severity" : "any",
      "facility" : "any"
    }, {
      "severity" : "any",
      "facility" : "any"
    }, {
      "severity" : "any",
      "facility" : "any"
    }, {
      "severity" : "any",
      "facility" : "any"
    }, {
      "severity" : "any",
      "facility" : "any"
    } ],
    "username" : "username"
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_host_value

Up
get /api/host/{host}/rulegroups
List host rulegroups (hostGetRulegroups)
List host rulegroups.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_rulegroup_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_list

Up
get /api/host/{host}/uploads
List host uploads (hostGetUploads)
List host uploads.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Return type

response_upload_list

Example data

Content-Type: application/json
{
  "result" : [ {
    "file" : "file",
    "start" : 0,
    "end" : 6,
    "serialno" : 0
  }, {
    "file" : "file",
    "start" : 0,
    "end" : 6,
    "serialno" : 0
  } ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_upload_list

Up
post /api/host/{host}
Add/edit host details (hostSet)
Add/edit host details.

Path parameters

host (required)
Path Parameter — Name of host. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

host_value host_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/hosts
List hosts (hostsGet)
List hosts.

Return type

response_host_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_host_list

Profiles

Up
delete /api/profile
Delete profile (profileDelete)
Delete profile.

Path parameters

host (required)
Path Parameter — Name of profile. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/profile
Get profile details (profileGet)
Get profile details.

Path parameters

host (required)
Path Parameter — Name of profile. default: null

Return type

response_profile_value

Example data

Content-Type: application/json
{
  "result" : {
    "notes" : "notes",
    "excludes" : [ null, null, null, null, null ],
    "inherit" : "inherit",
    "includes" : [ null, null, null, null, null ]
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_profile_value

Up
post /api/profile
Add/edit profile details (profileSet)
Add/edit profile details.

Path parameters

profile (required)
Path Parameter — Name of profile. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

profile_value profile_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/profiles
List profiles (profilesGet)
List profiles.

Return type

response_profile_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_profile_list

Rulegroups

Up
put /api/rulegroup/{rulegroup}/activate
Activate rulegroup (rulegroupActivate)
Activate rulegroup.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
put /api/rulegroup/{rulegroup}/deactivate
Deactivate rulegroup (rulegroupDeactivate)
Deativate rulegroup.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
delete /api/rulegroup/{rulegroup}
Delete rulegroup (rulegroupDelete)
Delete rulegroup.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
delete /api/rulegroup/{rulegroup}/global/{global}
Delete rulegroup global (rulegroupDeleteGlobal)
Delete rulegroup global.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
global (required)
Path Parameter — Name of global. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
delete /api/rulegroup/{rulegroup}/rule/{rule}
Delete rulegroup rule (rulegroupDeleteRule)
Delete rulegroup rule.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
rule (required)
Path Parameter — Name of rule. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/rulegroup/{rulegroup}
Get rulegroup details (rulegroupGet)
Get rulegroup details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_rulegroup_value

Example data

Content-Type: application/json
{
  "result" : {
    "prototypes" : [ "prototypes", "prototypes", "prototypes", "prototypes", "prototypes" ],
    "globals" : {
      "key" : {
        "indices" : [ null, null, null ]
      }
    },
    "rules" : {
      "key" : {
        "regex" : "regex",
        "action" : "insert",
        "subst" : [ {
          "find" : "find",
          "replace" : "replace",
          "modifiers" : "modifiers"
        }, {
          "find" : "find",
          "replace" : "replace",
          "modifiers" : "modifiers"
        }, {
          "find" : "find",
          "replace" : "replace",
          "modifiers" : "modifiers"
        }, {
          "find" : "find",
          "replace" : "replace",
          "modifiers" : "modifiers"
        }, {
          "find" : "find",
          "replace" : "replace",
          "modifiers" : "modifiers"
        } ],
        "priority" : 15,
        "event" : "none",
        "fields" : [ {
          "name" : "name",
          "insert" : "insert",
          "type" : "keyword",
          "value" : "value"
        }, {
          "name" : "name",
          "insert" : "insert",
          "type" : "keyword",
          "value" : "value"
        }, {
          "name" : "name",
          "insert" : "insert",
          "type" : "keyword",
          "value" : "value"
        }, {
          "name" : "name",
          "insert" : "insert",
          "type" : "keyword",
          "value" : "value"
        }, {
          "name" : "name",
          "insert" : "insert",
          "type" : "keyword",
          "value" : "value"
        } ],
        "updates" : [ {
          "field" : "field",
          "value" : "value",
          "parameters" : [ "parameters", "parameters", "parameters" ]
        }, {
          "field" : "field",
          "value" : "value",
          "parameters" : [ "parameters", "parameters", "parameters" ]
        }, {
          "field" : "field",
          "value" : "value",
          "parameters" : [ "parameters", "parameters", "parameters" ]
        }, {
          "field" : "field",
          "value" : "value",
          "parameters" : [ "parameters", "parameters", "parameters" ]
        }, {
          "field" : "field",
          "value" : "value",
          "parameters" : [ "parameters", "parameters", "parameters" ]
        } ]
      }
    },
    "properties" : {
      "created" : 0,
      "author" : "author",
      "organization" : "organization",
      "title" : "title",
      "updated" : 6,
      "version" : "version"
    }
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_value

Up
get /api/rulegroup/{rulegroup}/global/{global}
Get rulegroup global details (rulegroupGetGlobal)
et rulegroup global details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
global (required)
Path Parameter — Name of global. default: null

Return type

response_rulegroup_global_value

Example data

Content-Type: application/json
{
  "result" : {
    "indices" : [ null, null, null ]
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_global_value

Up
get /api/rulegroup/{rulegroup}/globals
List rulegroup globals (rulegroupGetGlobals)
List rulegroups globals.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_rulegroup_global_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_global_list

Up
get /api/rulegroup/{rulegroup}/properties
Get rulegroup properties (rulegroupGetProperties)
Get rulegroup properties.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_rulegroup_properties_value

Example data

Content-Type: application/json
{
  "result" : {
    "created" : 0,
    "author" : "author",
    "organization" : "organization",
    "title" : "title",
    "updated" : 6,
    "version" : "version"
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_properties_value

Up
get /api/rulegroup/{rulegroup}/prototypes
Get rulegroup prototypes (rulegroupGetPrototypes)
Get rulegroup prototypes.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_rulegroup_prototypes_value

Example data

Content-Type: application/json
{
  "result" : [ "result", "result", "result", "result", "result" ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_prototypes_value

Up
get /api/rulegroup/{rulegroup}/rule/{rule}
Get rulegroup rule details (rulegroupGetRule)
Get rulegroup rule details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
rule (required)
Path Parameter — Name of rule. default: null

Return type

response_rulegroup_rule_value

Example data

Content-Type: application/json
{
  "result" : {
    "regex" : "regex",
    "action" : "insert",
    "subst" : [ {
      "find" : "find",
      "replace" : "replace",
      "modifiers" : "modifiers"
    }, {
      "find" : "find",
      "replace" : "replace",
      "modifiers" : "modifiers"
    }, {
      "find" : "find",
      "replace" : "replace",
      "modifiers" : "modifiers"
    }, {
      "find" : "find",
      "replace" : "replace",
      "modifiers" : "modifiers"
    }, {
      "find" : "find",
      "replace" : "replace",
      "modifiers" : "modifiers"
    } ],
    "priority" : 15,
    "event" : "none",
    "fields" : [ {
      "name" : "name",
      "insert" : "insert",
      "type" : "keyword",
      "value" : "value"
    }, {
      "name" : "name",
      "insert" : "insert",
      "type" : "keyword",
      "value" : "value"
    }, {
      "name" : "name",
      "insert" : "insert",
      "type" : "keyword",
      "value" : "value"
    }, {
      "name" : "name",
      "insert" : "insert",
      "type" : "keyword",
      "value" : "value"
    }, {
      "name" : "name",
      "insert" : "insert",
      "type" : "keyword",
      "value" : "value"
    } ],
    "updates" : [ {
      "field" : "field",
      "value" : "value",
      "parameters" : [ "parameters", "parameters", "parameters" ]
    }, {
      "field" : "field",
      "value" : "value",
      "parameters" : [ "parameters", "parameters", "parameters" ]
    }, {
      "field" : "field",
      "value" : "value",
      "parameters" : [ "parameters", "parameters", "parameters" ]
    }, {
      "field" : "field",
      "value" : "value",
      "parameters" : [ "parameters", "parameters", "parameters" ]
    }, {
      "field" : "field",
      "value" : "value",
      "parameters" : [ "parameters", "parameters", "parameters" ]
    } ]
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_rule_value

Up
get /api/rulegroup/{rulegroup}/rules
List rulegroups rules (rulegroupGetRules)
List rulegroups rules.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Return type

response_rulegroup_rule_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_rule_list

Up
post /api/rulegroup/{rulegroup}
Add/edit rulegroup details (rulegroupSet)
Add/edit rulegroup details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rulegroup_value rulegroup_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
post /api/rulegroup/{rulegroup}/global/{global}
Add/edit rulegroup globals details (rulegroupSetGlobal)
Add/edit rulegroup globals details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
global (required)
Path Parameter — Name of global. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rulegroup_global_value rulegroup_global_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
post /api/rulegroup/{rulegroup}/properties
Set rulegroup properties (rulegroupSetProperties)
Set rulegroup properties.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rulegroup_properties_value rulegroup_properties_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
post /api/rulegroup/{rulegroup}/prototypes
Set rulegroup prototypes (rulegroupSetPrototypes)
Set rulegroup prototypes.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

string array (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
post /api/rulegroup/{rulegroup}/rule/{rule}
Add/edit rulegroup rule details (rulegroupSetRule)
Add/edit rulegroup rule details.

Path parameters

rulegroup (required)
Path Parameter — Name of rulegroup. default: null
rule (required)
Path Parameter — Name of rule. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

rulegroup_rule_value rulegroup_rule_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/rulegroups
List rulegroups (rulegroupsGet)
List rulegroups.

Return type

response_rulegroup_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_list

Up
get /api/rulegroups/active
List active rulegroups (rulegroupsGetActive)
List active rulegroups.

Return type

response_rulegroup_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_rulegroup_list

Spans

Up
delete /api/span/{span}
Delete span (spanDelete)
Delete span.

Path parameters

span (required)
Path Parameter — Name of span. default: null

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/span/{span}
Get span details (spanGet)
Get span details.

Path parameters

span (required)
Path Parameter — Name of span. default: null

Return type

response_span_value

Example data

Content-Type: application/json
{
  "result" : {
    "rows" : [ {
      "display" : "span_first_first",
      "match" : "field",
      "term" : "term",
      "label" : "label"
    }, {
      "display" : "span_first_first",
      "match" : "field",
      "term" : "term",
      "label" : "label"
    }, {
      "display" : "span_first_first",
      "match" : "field",
      "term" : "term",
      "label" : "label"
    }, {
      "display" : "span_first_first",
      "match" : "field",
      "term" : "term",
      "label" : "label"
    }, {
      "display" : "span_first_first",
      "match" : "field",
      "term" : "term",
      "label" : "label"
    } ],
    "snap" : true
  },
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_span_value

Up
get /api/span/{span}/diagram/{host}/{serialno}
Get span diagram (spanGetDiagram)
Get span diagram.

Path parameters

span (required)
Path Parameter — Name of span. default: null
host (required)
Path Parameter — Name of host. default: null
serialno (required)
Path Parameter — Upload serial number. default: null

Return type

Object

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response Object

Up
post /api/span/{span}
Add/edit span details (spanSet)
Add/edit span details.

Path parameters

span (required)
Path Parameter — Name of span. default: null

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

span_value span_value (required)
Body Parameter

Return type

response_generic

Example data

Content-Type: application/json
{
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_generic

Up
get /api/spans
List spans (spansGet)
List spans.

Return type

response_span_list

Example data

Content-Type: application/json
{
  "result" : [ null, null ],
  "response" : {
    "result" : "result",
    "request" : "{}",
    "function" : "function",
    "syntax" : 1,
    "arguments" : [ "arguments", "arguments" ],
    "error" : "error"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Default response response_span_list

Models

[ Jump to Methods ]

Table of Contents

  1. event_config_value -
  2. event_value -
  3. feed_value -
  4. host_value -
  5. host_value_levels -
  6. profile_value -
  7. response_common -
  8. response_event_config_value -
  9. response_event_list -
  10. response_event_value -
  11. response_feed_list -
  12. response_feed_value -
  13. response_generic -
  14. response_host_list -
  15. response_host_value -
  16. response_profile_list -
  17. response_profile_value -
  18. response_rulegroup_global_list -
  19. response_rulegroup_global_value -
  20. response_rulegroup_list -
  21. response_rulegroup_properties_value -
  22. response_rulegroup_prototypes_value -
  23. response_rulegroup_rule_list -
  24. response_rulegroup_rule_value -
  25. response_rulegroup_value -
  26. response_span_list -
  27. response_span_value -
  28. response_upload_list -
  29. rulegroup_global_value -
  30. rulegroup_properties_value -
  31. rulegroup_rule_value -
  32. rulegroup_rule_value_fields -
  33. rulegroup_rule_value_subst -
  34. rulegroup_rule_value_updates -
  35. rulegroup_value -
  36. span_row -
  37. span_value -
  38. upload_value -

event_config_value - Up

smtp
email
webhookurl
webhookproxy

event_value - Up

Event record
record
active
posted

feed_value - Up

notes
type
Enum:
kafka
syslog
kafka_servers (optional)
kafka_topic (optional)
kafka_partition (optional)
kafka_offset (optional)
syslog_server (optional)

host_value - Up

Host record
hostname (optional)
timezone (optional)
username (optional)
password (optional)
profile
String Profile name
retention (optional)
levels
updated (optional)

host_value_levels - Up

facility
Enum:
any
authorization
change_log
conflict_log
daemon
dfc
external
firewall
ftp
interactive_commands
kernel
ntp
pfe
security
user
severity
Enum:
any
info
notice
warning
error
critical
alert
emergency
none

profile_value - Up

Profile record
notes
inherit
String Profile name
includes
excludes

response_common - Up

result (optional)
error (optional)
function (optional)
syntax (optional)
Integer Supported API version
request (optional)
arguments (optional)

response_event_config_value - Up

response (optional)
result (optional)

response_event_list - Up

response (optional)
result (optional)
array[String] Event name list

response_event_value - Up

response (optional)
result (optional)

response_feed_list - Up

response (optional)
result (optional)
array[String] Feed name list

response_feed_value - Up

response (optional)
result (optional)

response_generic - Up

response (optional)

response_host_list - Up

response (optional)
result (optional)
array[String] Host name list

response_host_value - Up

response (optional)
result (optional)

response_profile_list - Up

response (optional)
result (optional)
array[String] Profile name list

response_profile_value - Up

response (optional)
result (optional)

response_rulegroup_global_list - Up

response (optional)
result (optional)
array[String] Rulegroup global name list

response_rulegroup_global_value - Up

response (optional)
result (optional)

response_rulegroup_list - Up

response (optional)
result (optional)
array[String] Rulegroup name list

response_rulegroup_properties_value - Up

response (optional)
result (optional)

response_rulegroup_prototypes_value - Up

response (optional)
result (optional)
array[String] Rulegroup prototypes

response_rulegroup_rule_list - Up

response (optional)
result (optional)
array[String] Rulegroup rule name list

response_rulegroup_rule_value - Up

response (optional)
result (optional)

response_rulegroup_value - Up

response (optional)
result (optional)

response_span_list - Up

response (optional)
result (optional)
array[String] Span name list

response_span_value - Up

response (optional)
result (optional)

response_upload_list - Up

response (optional)
result (optional)
array[upload_value] Host upload list

rulegroup_global_value - Up

Rulegroup global record
indices

rulegroup_properties_value - Up

Rulegroup properties
created
updated (optional)
author
organization
title
version

rulegroup_rule_value - Up

Rulegroup rule record
priority
action
Enum:
insert
modify
discard
event
Enum:
none
LFA
regex
subst (optional)
fields (optional)
updates (optional)

rulegroup_rule_value_fields - Up

name
type
Enum:
keyword
boolean
binary
byte
short
integer
long
float
double
date
ip
span_start
span_end
span_event
value
insert

rulegroup_rule_value_subst - Up

modifiers
find
replace

rulegroup_rule_value_updates - Up

field
String Rulegroup global name
value
parameters

rulegroup_value - Up

Rulegroup record
properties
prototypes (optional)
array[String] Rulegroup prototypes
globals (optional)
rules (optional)

span_row - Up

Span row record
match
Enum:
field
field_regex
value
value_regex
display
Enum:
span_first_first
span_first_last
span_last_first
span_last_last
span_multiple
event_first
event_last
event_multiple
label
term

span_value - Up

Span record
snap
rows

upload_value - Up

Host upload record
start
end
file
serialno
Integer Upload serial number.