Graylog API swagger file

graylog-api.json

{
    "apiVersion": "3.1.3+cda805f",
    "swaggerVersion": "1.2",
    "apis": [
        {
            "path": "/streams/{streamid}/alerts/{alertId}/history",
            "name": "AlarmCallbackHistories",
            "description": "Manage stream alarm callback histories"
        },
        {
            "path": "/alerts/callbacks",
            "name": "AlarmCallbacks",
            "description": "Manage alarm callbacks (aka alert notifications)"
        },
        {
            "path": "/alerts/conditions",
            "name": "AlertConditions",
            "description": "Manage stream alert conditions"
        },
        {
            "path": "/streams/alerts",
            "name": "Alerts",
            "description": "Manage stream alerts for all streams"
        },
        {
            "path": "/cluster",
            "name": "Cluster",
            "description": "System information of all nodes in the cluster"
        },
        {
            "path": "/cluster/deflector",
            "name": "Cluster/Deflector",
            "description": "Cluster-wide deflector handling"
        },
        {
            "path": "/cluster/inputstates",
            "name": "Cluster/InputState",
            "description": "Cluster-wide input states"
        },
        {
            "path": "/cluster/jobs",
            "name": "Cluster/Jobs",
            "description": "Cluster-wide System Jobs"
        },
        {
            "path": "/cluster/{nodeId}/journal",
            "name": "Cluster/Journal",
            "description": "Journal information of any nodes in the cluster"
        },
        {
            "path": "/cluster/{nodeId}/lbstatus",
            "name": "Cluster/LoadBalancers",
            "description": "Cluster-wide status propagation for LB"
        },
        {
            "path": "/cluster/metrics",
            "name": "Cluster/Metrics",
            "description": "Cluster-wide Internal Graylog metrics"
        },
        {
            "path": "/cluster/{nodeId}/metrics",
            "name": "Cluster/Node/Metrics",
            "description": "Cluster-wide Internal Graylog node metrics"
        },
        {
            "path": "/cluster/{nodeId}/plugins",
            "name": "Cluster/Plugins",
            "description": "Plugin information for any node in the cluster"
        },
        {
            "path": "/cluster/{nodeId}/processing",
            "name": "Cluster/Processing",
            "description": "Cluster-wide processing status control."
        },
        {
            "path": "/cluster/processing/status",
            "name": "Cluster/Processing/Status",
            "description": ""
        },
        {
            "path": "/cluster/{nodeId}/shutdown",
            "name": "Cluster/Shutdown",
            "description": "Shutdown gracefully nodes in cluster"
        },
        {
            "path": "/cluster/system/loggers",
            "name": "Cluster/System/Loggers",
            "description": "Cluster-wide access to internal Graylog loggers"
        },
        {
            "path": "/count",
            "name": "Counts",
            "description": "Message counts"
        },
        {
            "path": "/dashboards",
            "name": "Dashboards",
            "description": "Manage dashboards"
        },
        {
            "path": "/dashboards/{dashboardId}/widgets",
            "name": "Dashboards/Widgets",
            "description": "Manage widgets of an existing dashboard"
        },
        {
            "path": "/api-docs",
            "name": "Documentation",
            "description": "Documentation of this API in JSON format."
        },
        {
            "path": "/views/fields",
            "name": "Enterprise/Field Types",
            "description": "Field Types"
        },
        {
            "path": "/views/search",
            "name": "Enterprise/Search",
            "description": ""
        },
        {
            "path": "/views/functions",
            "name": "Enterprise/Search/Functions",
            "description": "Definitions for aggregation functions"
        },
        {
            "path": "/views/{id}/share",
            "name": "Enterprise/Views",
            "description": "View Sharing management"
        },
        {
            "path": "/views",
            "name": "Enterprise/Views",
            "description": "Views management"
        },
        {
            "path": "/views/forValue",
            "name": "Enterprise/Views/QualifyingViews",
            "description": "List qualifying views for view interlinking"
        },
        {
            "path": "/events",
            "name": "Events",
            "description": "Events overview and search"
        },
        {
            "path": "/events/definitions",
            "name": "Events/Definitions",
            "description": "Event definition management"
        },
        {
            "path": "/events/entity_types",
            "name": "Events/EntityTypes",
            "description": "Event entity types"
        },
        {
            "path": "/events/notifications",
            "name": "Events/Notifications",
            "description": "Manage event notifications"
        },
        {
            "path": "/system/inputs/{inputId}/extractors",
            "name": "Extractors",
            "description": "Extractors of an input"
        },
        {
            "path": "/",
            "name": "Hello World",
            "description": "A friendly hello world message"
        },
        {
            "path": "/system/indexer/cluster",
            "name": "Indexer/Cluster",
            "description": "Indexer cluster information"
        },
        {
            "path": "/system/indexer/failures",
            "name": "Indexer/Failures",
            "description": "Indexer failures"
        },
        {
            "path": "/system/indexer/indices",
            "name": "Indexer/Indices",
            "description": "Index information"
        },
        {
            "path": "/system/indexer/indices/templates",
            "name": "Indexer/Indices/Templates",
            "description": "Index Template Management"
        },
        {
            "path": "/system/indexer/overview",
            "name": "Indexer/Overview",
            "description": "Indexing overview"
        },
        {
            "path": "/scheduler",
            "name": "JobScheduler",
            "description": "Scheduler management"
        },
        {
            "path": "/search/mapdata",
            "name": "MapWidget",
            "description": "Get map data"
        },
        {
            "path": "/messages",
            "name": "Messages",
            "description": "Single messages"
        },
        {
            "path": "/system/pipelines/connections",
            "name": "Pipelines/Connections",
            "description": "Stream connections of processing pipelines"
        },
        {
            "path": "/system/pipelines/pipeline",
            "name": "Pipelines/Pipelines",
            "description": "Pipelines for the pipeline message processor"
        },
        {
            "path": "/system/pipelines/rule",
            "name": "Pipelines/Rules",
            "description": "Rules for the pipeline message processor"
        },
        {
            "path": "/system/pipelines/simulate",
            "name": "Pipelines/Simulator",
            "description": "Simulate pipeline message processor"
        },
        {
            "path": "/plugins/org.graylog.plugins.archive/archives",
            "name": "Plugins/Archive/Archives",
            "description": "Manage index archives"
        },
        {
            "path": "/plugins/org.graylog.plugins.archive/backends",
            "name": "Plugins/Archive/Backends",
            "description": "Manage archive backends"
        },
        {
            "path": "/plugins/org.graylog.plugins.archive/config",
            "name": "Plugins/Archive/Config",
            "description": "Manage archive config"
        },
        {
            "path": "/plugins/org.graylog.plugins.auditlog/entries",
            "name": "Plugins/AuditLog/Entries",
            "description": "Access audit log entries"
        },
        {
            "path": "/plugins/org.graylog.plugins.auditlog/status",
            "name": "Plugins/AuditLog/Status",
            "description": "Show audit log status"
        },
        {
            "path": "/plugins/org.graylog.plugins.collector/",
            "name": "Plugins/CollectorConfiguration",
            "description": "Manage collector configurations"
        },
        {
            "path": "/plugins/org.graylog.plugins.enterprise/views/forValue",
            "name": "Plugins/Enterprise/Views/QualifyingViews",
            "description": "List qualifying views for view interlinking"
        },
        {
            "path": "/plugins/org.graylog.plugins.report/reports",
            "name": "Plugins/Reports",
            "description": "Manage automated PDF reports"
        },
        {
            "path": "/plugins/org.graylog.plugins.collector/collectors",
            "name": "Plugins/System/Collectors",
            "description": "Management of Graylog Collectors."
        },
        {
            "path": "/plugins/org.graylog.plugins.license/licenses",
            "name": "Plugins/System/Licenses",
            "description": "Manage Graylog licenses"
        },
        {
            "path": "/roles",
            "name": "Roles",
            "description": "User roles"
        },
        {
            "path": "/search/universal/absolute",
            "name": "Search/Absolute",
            "description": "Message search"
        },
        {
            "path": "/search/decorators",
            "name": "Search/Decorators",
            "description": "Message search decorators"
        },
        {
            "path": "/search/universal/keyword",
            "name": "Search/Keyword",
            "description": "Message search"
        },
        {
            "path": "/search/universal/relative",
            "name": "Search/Relative",
            "description": "Message search"
        },
        {
            "path": "/search/saved",
            "name": "Search/Saved",
            "description": "Saved searches"
        },
        {
            "path": "/sidecars",
            "name": "Sidecar",
            "description": "Manage Sidecar fleet"
        },
        {
            "path": "/sidecar/administration",
            "name": "Sidecar/Administration",
            "description": "Administrate sidecars"
        },
        {
            "path": "/sidecar/action",
            "name": "Sidecar/Collector/Actions",
            "description": "Manage Collector actions"
        },
        {
            "path": "/sidecar/collectors",
            "name": "Sidecar/Collectors",
            "description": "Manage collectors"
        },
        {
            "path": "/sidecar/configuration_variables",
            "name": "Sidecar/ConfigurationVariables",
            "description": "Manage collector configuration variables"
        },
        {
            "path": "/sidecar/configurations",
            "name": "Sidecar/Configurations",
            "description": "Manage/Render collector configurations"
        },
        {
            "path": "/sources",
            "name": "Sources",
            "description": "Listing message sources (e.g. hosts sending logs)"
        },
        {
            "path": "/system/inputs/{inputId}/staticfields",
            "name": "StaticFields",
            "description": "Static fields of an input"
        },
        {
            "path": "/streams/{streamid}/alarmcallbacks",
            "name": "Stream/AlarmCallbacks",
            "description": "Manage stream alarm callbacks"
        },
        {
            "path": "/streams/{streamId}/alerts/conditions",
            "name": "Stream/AlertConditions",
            "description": "Manage stream alert conditions"
        },
        {
            "path": "/streams/{streamId}/alerts",
            "name": "Stream/Alerts",
            "description": "Manage stream alerts for a given stream"
        },
        {
            "path": "/streams/{streamid}/outputs",
            "name": "StreamOutputs",
            "description": "Manage stream outputs for a given stream"
        },
        {
            "path": "/streams/{streamid}/rules",
            "name": "StreamRules",
            "description": "Manage stream rules"
        },
        {
            "path": "/streams",
            "name": "Streams",
            "description": "Manage streams"
        },
        {
            "path": "/system",
            "name": "System",
            "description": "System information of this node."
        },
        {
            "path": "/system/authentication",
            "name": "System/Authentication",
            "description": "Manage authentication providers"
        },
        {
            "path": "/system/catalog",
            "name": "System/Catalog",
            "description": "Entity Catalog"
        },
        {
            "path": "/system/cluster",
            "name": "System/Cluster",
            "description": "Node discovery"
        },
        {
            "path": "/system/cluster_config",
            "name": "System/ClusterConfig",
            "description": "Graylog Cluster Configuration"
        },
        {
            "path": "/system/cluster/stats",
            "name": "System/ClusterStats",
            "description": "Cluster stats"
        },
        {
            "path": "/system/cluster/traffic",
            "name": "System/ClusterTraffic",
            "description": "Cluster traffic stats"
        },
        {
            "path": "/system/codecs/types",
            "name": "System/Codecs/Types",
            "description": "Message codec types of this node"
        },
        {
            "path": "/system/configuration",
            "name": "System/Configuration",
            "description": "Read-only access to configuration settings"
        },
        {
            "path": "/system/content_packs",
            "name": "System/ContentPacks",
            "description": "Content Packs"
        },
        {
            "path": "/system/debug/events",
            "name": "System/Debug/Events",
            "description": "For debugging local and cluster events."
        },
        {
            "path": "/system/deflector",
            "name": "System/Deflector",
            "description": "Index deflector management"
        },
        {
            "path": "/system/fields",
            "name": "System/Fields",
            "description": "Get list of message fields that exist."
        },
        {
            "path": "/system/gettingstarted",
            "name": "System/GettingStartedGuides",
            "description": "Getting Started guide"
        },
        {
            "path": "/system/grok",
            "name": "System/Grok",
            "description": "Manage grok patterns"
        },
        {
            "path": "/system/indices/ranges",
            "name": "System/IndexRanges",
            "description": "Index timeranges"
        },
        {
            "path": "/system/indices/index_sets",
            "name": "System/IndexSets",
            "description": "Index sets"
        },
        {
            "path": "/system/indices/retention",
            "name": "System/Indices/Retention",
            "description": "Index retention strategy settings"
        },
        {
            "path": "/system/indices/rotation",
            "name": "System/Indices/Rotation",
            "description": "Index rotation strategy settings"
        },
        {
            "path": "/system/inputstates",
            "name": "System/InputStates",
            "description": "Message input states of this node"
        },
        {
            "path": "/system/inputs",
            "name": "System/Inputs",
            "description": "Message inputs"
        },
        {
            "path": "/system/inputs/types",
            "name": "System/Inputs/Types",
            "description": "Message input types of this node"
        },
        {
            "path": "/system/jobs",
            "name": "System/Jobs",
            "description": "System Jobs"
        },
        {
            "path": "/system/journal",
            "name": "System/Journal",
            "description": "Message journal information of this node."
        },
        {
            "path": "/system/ldap",
            "name": "System/LDAP",
            "description": "LDAP settings"
        },
        {
            "path": "/system/lbstatus",
            "name": "System/LoadBalancers",
            "description": "Status propagation for load balancers"
        },
        {
            "path": "/system/loggers",
            "name": "System/Loggers",
            "description": "Internal Graylog loggers"
        },
        {
            "path": "/system/lookup",
            "name": "System/Lookup",
            "description": "Lookup tables"
        },
        {
            "path": "/system/messageprocessors",
            "name": "System/MessageProcessors",
            "description": "Manage message processors"
        },
        {
            "path": "/system/messages",
            "name": "System/Messages",
            "description": "Internal Graylog messages"
        },
        {
            "path": "/system/metrics",
            "name": "System/Metrics",
            "description": "Internal Graylog metrics"
        },
        {
            "path": "/system/metrics/{metricName}/history",
            "name": "System/Metrics/History",
            "description": "Get history of metrics"
        },
        {
            "path": "/system/notifications",
            "name": "System/Notifications",
            "description": "Notifications generated by the system"
        },
        {
            "path": "/system/outputs",
            "name": "System/Outputs",
            "description": "Manage outputs"
        },
        {
            "path": "/system/permissions",
            "name": "System/Permissions",
            "description": "Retrieval of system permissions."
        },
        {
            "path": "/system/plugins",
            "name": "System/Plugins",
            "description": "Plugin information"
        },
        {
            "path": "/system/processing",
            "name": "System/Processing",
            "description": "System processing status control."
        },
        {
            "path": "/system/processing/status",
            "name": "System/Processing/Status",
            "description": ""
        },
        {
            "path": "/system/serviceManager",
            "name": "System/ServiceManager",
            "description": "ServiceManager Status"
        },
        {
            "path": "/system/sessions",
            "name": "System/Sessions",
            "description": "Login for interactive user sessions"
        },
        {
            "path": "/system/shutdown",
            "name": "System/Shutdown",
            "description": "Shutdown this node gracefully."
        },
        {
            "path": "/system/stats",
            "name": "System/Stats",
            "description": "Node system stats"
        },
        {
            "path": "/system/throughput",
            "name": "System/Throughput",
            "description": "Message throughput of this node"
        },
        {
            "path": "/users",
            "name": "Users",
            "description": "User accounts"
        }
    ]
}