Created
November 24, 2020 02:31
-
-
Save asachs01/f1f317b2924a688deb8ed2520a4520bd to your computer and use it in GitHub Desktop.
A listing of all api endpoints & routes for Graylog
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/streams/streamid/alerts/alertId/history" | |
| } | |
| { | |
| "models": { | |
| "AlarmCallbackListSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:alarmcallbacks:AlarmCallbackListSummary", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "alarmcallbacks": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:alarmcallbacks:AlarmCallbackSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/alerts/callbacks", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all alarm callbacks", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AlarmCallbackListSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/alerts/callbacks/types", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all alarm callbacks types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "available", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AvailableAlarmCallbacksResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/alerts/callbacks/{alarmCallbackId}/test", | |
| "operations": [ | |
| { | |
| "summary": "Send a test alert for a given alarm callback", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "test", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "alarmCallbackId", | |
| "description": "The alarm callback id to send a test alert for.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Alarm callback not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while testing alarm callback" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/alerts/callbacks" | |
| } | |
| { | |
| "models": { | |
| "AlertConditionListSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertConditionListSummary", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "conditions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertConditionSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "in_grace": { | |
| "type": "boolean" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/alerts/conditions", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all alert conditions", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AlertConditionListSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/alerts/conditions/types", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all alert condition types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "available", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/alerts/conditions" | |
| } | |
| { | |
| "models": { | |
| "AlertListSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertListSummary", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "alerts": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "condition_id": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "condition_parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "triggered_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "resolved_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "is_interval": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "AlertSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "condition_id": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "condition_parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "triggered_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "resolved_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "is_interval": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/streams/alerts", | |
| "operations": [ | |
| { | |
| "summary": "Get the most recent alarms of all streams.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listRecent", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AlertListSummary", | |
| "parameters": [ | |
| { | |
| "name": "since", | |
| "description": "Optional parameter to define a lower date boundary. (UNIX timestamp)", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "0", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of alerts to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "300", | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/alerts/paginated", | |
| "operations": [ | |
| { | |
| "summary": "Get alarms of all streams, filtered by specifying limit and offset parameters.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listPaginated", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AlertListSummary", | |
| "parameters": [ | |
| { | |
| "name": "skip", | |
| "description": "The number of elements to skip (offset).", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "0", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "The maximum number of elements to return.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "300", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "state", | |
| "description": "Alert state (resolved/unresolved)", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/alerts/{alertId}", | |
| "operations": [ | |
| { | |
| "summary": "Get an alert by ID.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AlertSummary", | |
| "parameters": [ | |
| { | |
| "name": "alertId", | |
| "description": "The alert ID to retrieve.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Alert not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/streams/alerts" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/authz/grants-overview", | |
| "operations": [ | |
| { | |
| "summary": "Return an overview of all grants in the system", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getOverview", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/authz/grants-overview" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/authz/roles", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of all roles", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getList", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/user/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list roles for a user", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getListForUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/{roleId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single role", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AuthzRoleDTO", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/{roleId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a role", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/{roleId}/assignee/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Remove user from role", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "removeUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "username", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/{roleId}/assignees", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of users for a role", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getUsersForRole", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/roles/{roleId}/assignees", | |
| "operations": [ | |
| { | |
| "summary": "Add user to role", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "addUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "usernames", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Set" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/authz/roles" | |
| } | |
| { | |
| "models": { | |
| "EntityShareRequest": { | |
| "id": "urn:jsonschema:org:graylog:security:shares:EntityShareRequest", | |
| "properties": { | |
| "selected_grantee_capabilities": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string", | |
| "enum": [ | |
| "view", | |
| "manage", | |
| "own" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/authz/shares/entities/{entityGRN}", | |
| "operations": [ | |
| { | |
| "summary": "Create / update shares for an entity or collection", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "updateEntityShares", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "entityGRN", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EntityShareRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/shares/entities/{entityGRN}/prepare", | |
| "operations": [ | |
| { | |
| "summary": "Prepare shares for an entity or collection", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "prepareShare", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "EntityShareResponse", | |
| "parameters": [ | |
| { | |
| "name": "entityGRN", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EntityShareRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/authz/shares/user/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Return shares for a user", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "pagination parameters", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PaginationParameters" | |
| }, | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "capability", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "entity_type", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/authz/shares" | |
| } | |
| { | |
| "models": { | |
| "SystemProcessBufferDumpResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemProcessBufferDumpResponse", | |
| "properties": { | |
| "processbuffer_dump": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SystemThreadDumpResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemThreadDumpResponse", | |
| "properties": { | |
| "threaddump": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SystemJVMResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemJVMResponse", | |
| "properties": { | |
| "free_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "max_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "used_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "pid": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster", | |
| "operations": [ | |
| { | |
| "summary": "Get system overview of all Graylog nodes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/processbufferdump", | |
| "operations": [ | |
| { | |
| "summary": "Get a process buffer dump of all cluster nodes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "clusterProcessBufferDump", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/{nodeId}/jvm", | |
| "operations": [ | |
| { | |
| "summary": "Get JVM information of the given node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "jvm", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJVMResponse", | |
| "parameters": [ | |
| { | |
| "name": "nodeId", | |
| "description": "The id of the node to retrieve JVM information.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/{nodeId}/processbufferdump", | |
| "operations": [ | |
| { | |
| "summary": "Get a process buffer dump of the given node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "processBufferDump", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemProcessBufferDumpResponse", | |
| "parameters": [ | |
| { | |
| "name": "nodeId", | |
| "description": "The id of the node to get a process buffer dump.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/{nodeId}/threaddump", | |
| "operations": [ | |
| { | |
| "summary": "Get a thread dump of the given node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "threadDump", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemThreadDumpResponse", | |
| "parameters": [ | |
| { | |
| "name": "nodeId", | |
| "description": "The id of the node to get a thread dump.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/cluster" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/deflector/cycle", | |
| "operations": [ | |
| { | |
| "summary": "Finds master node and triggers deflector cycle", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "cycle", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/deflector/{indexSetId}/cycle", | |
| "operations": [ | |
| { | |
| "summary": "Finds master node and triggers deflector cycle", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "cycle", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/cluster/deflector" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/inputstates", | |
| "operations": [ | |
| { | |
| "summary": "Get all input states", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/inputstates/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Start or restart specified input in all nodes", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "start", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/inputstates/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Stop specified input in all nodes", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "stop", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/cluster/inputstates" | |
| } | |
| { | |
| "models": { | |
| "SystemJobSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:SystemJobSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "percent_complete": { | |
| "type": "integer" | |
| }, | |
| "is_cancelable": { | |
| "type": "boolean" | |
| }, | |
| "provides_progress": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/jobs", | |
| "operations": [ | |
| { | |
| "summary": "List currently running jobs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/jobs/{jobId}", | |
| "operations": [ | |
| { | |
| "summary": "Cancel job with the given ID", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "cancelJob", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/jobs/{jobId}", | |
| "operations": [ | |
| { | |
| "summary": "Get job with the given ID", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getJob", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/cluster/jobs" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/cluster/nodeId/journal" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/cluster/nodeId/lbstatus" | |
| } | |
| { | |
| "models": { | |
| "MetricsReadRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:metrics:requests:MetricsReadRequest", | |
| "properties": { | |
| "metrics": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/metrics/multiple", | |
| "operations": [ | |
| { | |
| "summary": "Get all metrics of all nodes in the cluster", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "multipleMetricsAllNodes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "Requested metrics", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MetricsReadRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Malformed body" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/cluster/metrics" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/cluster/nodeId/metrics" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/cluster/nodeId/plugins" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/cluster/nodeId/processing" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/processing/status", | |
| "operations": [ | |
| { | |
| "summary": "Get processing status from all nodes in the cluster", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/processing/status/persisted", | |
| "operations": [ | |
| { | |
| "summary": "Get persisted processing status from all nodes in the cluster", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPersistedStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/cluster/processing/status" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/cluster/nodeId/shutdown" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/cluster/system/loggers", | |
| "operations": [ | |
| { | |
| "summary": "List all loggers of all nodes and their current levels", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "loggers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/system/loggers/subsystems", | |
| "operations": [ | |
| { | |
| "summary": "List all logger subsystems and their current levels", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "subsystems", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/cluster/system/loggers/{nodeId}/subsystems/{subsystem}/level/{level}", | |
| "operations": [ | |
| { | |
| "summary": "Set the loglevel of a whole subsystem", | |
| "notes": "Provided level is falling back to DEBUG if it does not exist", | |
| "method": "PUT", | |
| "nickname": "setSubsystemLoggerLevel", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "nodeId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "subsystem", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "level", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such subsystem." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/cluster/system/loggers" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/dashboards", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all dashboards", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "views", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/dashboards" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/api-docs", | |
| "operations": [ | |
| { | |
| "summary": "Get API documentation", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "overview", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/api-docs/global", | |
| "operations": [ | |
| { | |
| "summary": "Get API documentation with cluster global URI path", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "globalOverview", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/api-docs/{route: .+}", | |
| "operations": [ | |
| { | |
| "summary": "Get detailed API documentation of a single resource", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "route", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "route", | |
| "description": "Route to fetch. For example /system", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/api-docs" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/free-enterprise/license", | |
| "operations": [ | |
| { | |
| "summary": "Request free Graylog Enterprise license", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "requestFreeLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/free-enterprise/license/info", | |
| "operations": [ | |
| { | |
| "summary": "Get Graylog Enterprise license info", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "licenseInfo", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/free-enterprise" | |
| } | |
| { | |
| "models": { | |
| "EventsSearchParameters": { | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchParameters", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchFilter", | |
| "properties": { | |
| "event_definitions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "alerts": { | |
| "type": "string", | |
| "enum": [ | |
| "include", | |
| "exclude", | |
| "only" | |
| ] | |
| } | |
| } | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "sort_direction": { | |
| "type": "string", | |
| "enum": [ | |
| "asc", | |
| "desc" | |
| ] | |
| }, | |
| "sort_by": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "EventsSearchResult": { | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchResult", | |
| "properties": { | |
| "total_events": { | |
| "type": "integer" | |
| }, | |
| "context": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchResult:Context", | |
| "properties": { | |
| "event_definitions": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchResult:ContextEntity", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "streams": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:events:search:EventsSearchResult:ContextEntity" | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchParameters", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchFilter", | |
| "properties": { | |
| "event_definitions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "alerts": { | |
| "type": "string", | |
| "enum": [ | |
| "include", | |
| "exclude", | |
| "only" | |
| ] | |
| } | |
| } | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "sort_direction": { | |
| "type": "string", | |
| "enum": [ | |
| "asc", | |
| "desc" | |
| ] | |
| }, | |
| "sort_by": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "duration": { | |
| "type": "integer" | |
| }, | |
| "events": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:search:EventsSearchResult:Event", | |
| "properties": { | |
| "event": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:event:EventDto", | |
| "properties": { | |
| "priority": { | |
| "type": "integer" | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "source": { | |
| "type": "string" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "alert": { | |
| "type": "boolean" | |
| }, | |
| "key_tuple": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "event_definition_id": { | |
| "type": "string" | |
| }, | |
| "source_streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timerange_end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "origin_context": { | |
| "type": "string" | |
| }, | |
| "event_definition_type": { | |
| "type": "string" | |
| }, | |
| "timestamp_processing": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "timerange_start": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "index_type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "used_indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/events/search", | |
| "operations": [ | |
| { | |
| "summary": "Search events", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "search", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "EventsSearchResult", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EventsSearchParameters" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/events" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "EventDefinitionDto": { | |
| "id": "urn:jsonschema:org:graylog:events:processor:EventDefinitionDto", | |
| "properties": { | |
| "notifications": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:notifications:EventNotificationHandler:Config", | |
| "properties": { | |
| "notification_parameters": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:notifications:NotificationParameters", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "notification_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:processor:EventProcessorConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "alert": { | |
| "type": "boolean" | |
| }, | |
| "notification_settings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:notifications:EventNotificationSettings", | |
| "properties": { | |
| "backlog_size": { | |
| "type": "integer" | |
| }, | |
| "grace_period_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "storage": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:processor:storage:EventStorageHandler:Config", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "key_spec": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "field_spec": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:fields:EventFieldSpec", | |
| "properties": { | |
| "data_type": { | |
| "type": "string", | |
| "enum": [ | |
| "string", | |
| "error" | |
| ] | |
| }, | |
| "providers": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:fields:providers:FieldValueProvider:Config", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "priority": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "EventProcessorParameters": { | |
| "id": "urn:jsonschema:org:graylog:events:processor:EventProcessorParameters", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ValidationResult": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:rest:ValidationResult", | |
| "properties": { | |
| "errors": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "error_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "failed": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/events/definitions", | |
| "operations": [ | |
| { | |
| "summary": "Create new event definition", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "schedule", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EventDefinitionDto" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions", | |
| "operations": [ | |
| { | |
| "summary": "List event definitions", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validate an event definition", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validate", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EventDefinitionDto" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Get an event definition", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "EventDefinitionDto", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Update existing event definition", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "schedule", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EventDefinitionDto" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete event definition", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}/execute", | |
| "operations": [ | |
| { | |
| "summary": "Execute event definition", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "execute", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "parameters", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "EventProcessorParameters" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}/schedule", | |
| "operations": [ | |
| { | |
| "summary": "Enable event definition", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "schedule", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}/unschedule", | |
| "operations": [ | |
| { | |
| "summary": "Disable event definition", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "unschedule", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/definitions/{definitionId}/with-context", | |
| "operations": [ | |
| { | |
| "summary": "Get an event definition", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getWithContext", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "definitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/events/definitions" | |
| } | |
| { | |
| "models": { | |
| "AvailableEntityTypesSummary": { | |
| "id": "urn:jsonschema:org:graylog:events:rest:AvailableEntityTypesResource:AvailableEntityTypesSummary", | |
| "properties": { | |
| "aggregation_functions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "processor_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "field_provider_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "storage_handler_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/events/entity_types", | |
| "operations": [ | |
| { | |
| "summary": "List all available entity types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AvailableEntityTypesSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/events/entity_types" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "NotificationDto": { | |
| "id": "urn:jsonschema:org:graylog:events:notifications:NotificationDto", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:events:notifications:EventNotificationConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/events/notifications", | |
| "operations": [ | |
| { | |
| "summary": "List all available notifications", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listNotifications", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications", | |
| "operations": [ | |
| { | |
| "summary": "Create new notification definition", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "NotificationDto" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/legacy/types", | |
| "operations": [ | |
| { | |
| "summary": "List all available legacy alarm callback types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "legacyTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/test", | |
| "operations": [ | |
| { | |
| "summary": "Send a test alert for a given event notification", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "test", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "NotificationDto" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Event notification is invalid." | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while testing event notification" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/{notificationId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a notification", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "NotificationDto", | |
| "parameters": [ | |
| { | |
| "name": "notificationId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/{notificationId}", | |
| "operations": [ | |
| { | |
| "summary": "Update existing notification", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "notificationId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "NotificationDto" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/{notificationId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a notification", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "notificationId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/events/notifications/{notificationId}/test", | |
| "operations": [ | |
| { | |
| "summary": "Send a test alert for a given event notification", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "test", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "notificationId", | |
| "description": "The event notification id to send a test alert for.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Event notification not found." | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while testing event notification" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/events/notifications" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/inputs/inputId/extractors" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/views/fields", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the field list of a given set of streams", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "byStreams", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/fields", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the list of all fields present in the system", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "allFieldTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/views/fields" | |
| } | |
| { | |
| "models": { | |
| "HelloWorldResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:HelloWorldResponse", | |
| "properties": { | |
| "tagline": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "cluster_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "", | |
| "operations": [ | |
| { | |
| "summary": "A few details about the Graylog node.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "helloWorld", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "HelloWorldResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "", | |
| "operations": [ | |
| { | |
| "summary": "Redirecting to web console if it runs on same port.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "redirectToWebConsole", | |
| "produces": [ | |
| "text/html", | |
| "application/xhtml+xml" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "" | |
| } | |
| { | |
| "models": { | |
| "ClusterName": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClusterName", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ClusterHealth": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClusterHealth", | |
| "properties": { | |
| "status": { | |
| "type": "string" | |
| }, | |
| "shards": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClusterHealth:ShardStatus", | |
| "properties": { | |
| "active": { | |
| "type": "integer" | |
| }, | |
| "initializing": { | |
| "type": "integer" | |
| }, | |
| "relocating": { | |
| "type": "integer" | |
| }, | |
| "unassigned": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indexer/cluster/health", | |
| "operations": [ | |
| { | |
| "summary": "Get cluster and shard health overview", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "clusterHealth", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClusterHealth", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/cluster/name", | |
| "operations": [ | |
| { | |
| "summary": "Get the cluster name", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "clusterName", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClusterName", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/indexer/cluster" | |
| } | |
| { | |
| "models": { | |
| "FailureCount": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:FailureCount", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indexer/failures", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of failed index operations.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "single", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "description": "Limit", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/failures/count", | |
| "operations": [ | |
| { | |
| "summary": "Total count of failed index operations since the given date.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "count", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "FailureCount", | |
| "parameters": [ | |
| { | |
| "name": "since", | |
| "description": "ISO8601 date", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid date parameter provided." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/indexer/failures" | |
| } | |
| { | |
| "models": { | |
| "OpenIndicesInfo": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:OpenIndicesInfo", | |
| "properties": { | |
| "indices": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexInfo", | |
| "properties": { | |
| "primary_shards": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats", | |
| "properties": { | |
| "flush": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "time_seconds": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "get": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "index": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "merge": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "refresh": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_query": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_fetch": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "open_search_contexts": { | |
| "type": "integer" | |
| }, | |
| "store_size_bytes": { | |
| "type": "integer" | |
| }, | |
| "segments": { | |
| "type": "integer" | |
| }, | |
| "documents": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:DocsStats", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "deleted": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "all_shards": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats" | |
| }, | |
| "routing": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ShardRouting", | |
| "properties": { | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_name": { | |
| "type": "string" | |
| }, | |
| "node_hostname": { | |
| "type": "string" | |
| }, | |
| "relocating_to": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "reopened": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "AllIndices": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:AllIndices", | |
| "properties": { | |
| "closed": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClosedIndices", | |
| "properties": { | |
| "indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "reopened": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClosedIndices" | |
| }, | |
| "all": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:OpenIndicesInfo", | |
| "properties": { | |
| "indices": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexInfo", | |
| "properties": { | |
| "primary_shards": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats", | |
| "properties": { | |
| "flush": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "time_seconds": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "get": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "index": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "merge": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "refresh": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_query": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_fetch": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "open_search_contexts": { | |
| "type": "integer" | |
| }, | |
| "store_size_bytes": { | |
| "type": "integer" | |
| }, | |
| "segments": { | |
| "type": "integer" | |
| }, | |
| "documents": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:DocsStats", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "deleted": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "all_shards": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats" | |
| }, | |
| "routing": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ShardRouting", | |
| "properties": { | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_name": { | |
| "type": "string" | |
| }, | |
| "node_hostname": { | |
| "type": "string" | |
| }, | |
| "relocating_to": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "reopened": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "IndicesReadRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:requests:IndicesReadRequest", | |
| "properties": { | |
| "indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "IndexInfo": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexInfo", | |
| "properties": { | |
| "primary_shards": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats", | |
| "properties": { | |
| "flush": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "time_seconds": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "get": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "index": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "merge": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "refresh": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_query": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "search_fetch": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:TimeAndTotalStats" | |
| }, | |
| "open_search_contexts": { | |
| "type": "integer" | |
| }, | |
| "store_size_bytes": { | |
| "type": "integer" | |
| }, | |
| "segments": { | |
| "type": "integer" | |
| }, | |
| "documents": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats:DocsStats", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "deleted": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "all_shards": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexStats" | |
| }, | |
| "routing": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ShardRouting", | |
| "properties": { | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "primary": { | |
| "type": "boolean" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_name": { | |
| "type": "string" | |
| }, | |
| "node_hostname": { | |
| "type": "string" | |
| }, | |
| "relocating_to": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "reopened": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "ClosedIndices": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClosedIndices", | |
| "properties": { | |
| "indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indexer/indices", | |
| "operations": [ | |
| { | |
| "summary": "List all open, closed and reopened indices.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AllIndices", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/closed", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of closed indices that can be reopened.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "closed", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClosedIndices", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/multiple", | |
| "operations": [ | |
| { | |
| "summary": "Get information of all specified indices and their shards.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "multiple", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "Requested indices", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "IndicesReadRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/open", | |
| "operations": [ | |
| { | |
| "summary": "Get information of all open indices managed by Graylog and their shards.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "open", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OpenIndicesInfo", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/reopened", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of reopened indices, which will not be cleaned by retention cleaning", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "reopened", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClosedIndices", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{indexSetId}/closed", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of closed indices that can be reopened.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "indexSetClosed", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClosedIndices", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{indexSetId}/list", | |
| "operations": [ | |
| { | |
| "summary": "List all open, closed and reopened indices.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "indexSetList", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AllIndices", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{indexSetId}/open", | |
| "operations": [ | |
| { | |
| "summary": "Get information of all open indices managed by Graylog and their shards.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "indexSetOpen", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OpenIndicesInfo", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{indexSetId}/reopened", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of reopened indices, which will not be cleaned by retention cleaning", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "indexSetReopened", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClosedIndices", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{index}", | |
| "operations": [ | |
| { | |
| "summary": "Delete an index. This will also trigger an index ranges rebuild job.", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "You cannot delete the current deflector target index." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{index}", | |
| "operations": [ | |
| { | |
| "summary": "Get information of an index and its shards.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "single", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexInfo", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{index}/close", | |
| "operations": [ | |
| { | |
| "summary": "Close an index. This will also trigger an index ranges rebuild job.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "close", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "You cannot close the current deflector target index." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/{index}/reopen", | |
| "operations": [ | |
| { | |
| "summary": "Reopen a closed index. This will also trigger an index ranges rebuild job.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "reopen", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/indexer/indices" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indexer/indices/templates", | |
| "operations": [ | |
| { | |
| "summary": "Get index templates for all index sets", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/templates/update", | |
| "operations": [ | |
| { | |
| "summary": "Updates the index templates for all index sets in Elasticsearch", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "syncAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/templates/{indexSetId}", | |
| "operations": [ | |
| { | |
| "summary": "Get index template for the given index set", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexTemplateResponse", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/indices/templates/{indexSetId}/update", | |
| "operations": [ | |
| { | |
| "summary": "Updates the index template for the given index set in Elasticsearch", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "sync", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexTemplateResponse", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/indexer/indices/templates" | |
| } | |
| { | |
| "models": { | |
| "IndexerOverview": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexerOverview", | |
| "properties": { | |
| "indexer_cluster": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexerClusterOverview", | |
| "properties": { | |
| "health": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClusterHealth", | |
| "properties": { | |
| "status": { | |
| "type": "string" | |
| }, | |
| "shards": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:ClusterHealth:ShardStatus", | |
| "properties": { | |
| "active": { | |
| "type": "integer" | |
| }, | |
| "initializing": { | |
| "type": "integer" | |
| }, | |
| "relocating": { | |
| "type": "integer" | |
| }, | |
| "unassigned": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "counts": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:count:responses:MessageCountResponse", | |
| "properties": { | |
| "events": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "indices": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexSummary", | |
| "properties": { | |
| "size": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexSizeSummary", | |
| "properties": { | |
| "events": { | |
| "type": "integer" | |
| }, | |
| "deleted": { | |
| "type": "integer" | |
| }, | |
| "bytes": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "range": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "is_deflector": { | |
| "type": "boolean" | |
| }, | |
| "is_closed": { | |
| "type": "boolean" | |
| }, | |
| "is_reopened": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "deflector": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:deflector:responses:DeflectorSummary", | |
| "properties": { | |
| "is_up": { | |
| "type": "boolean" | |
| }, | |
| "current_target": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indexer/overview", | |
| "operations": [ | |
| { | |
| "summary": "Get overview of current indexing state, including deflector config, cluster state, index ranges & message counts.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "index", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexerOverview", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indexer/overview/{indexSetId}", | |
| "operations": [ | |
| { | |
| "summary": "Get overview of current indexing state for the given index set, including deflector config, cluster state, index ranges & message counts.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "index", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexerOverview", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/indexer/overview" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/scheduler/jobs", | |
| "operations": [ | |
| { | |
| "summary": "Create new job definition", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JobDefinitionDto", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/jobs", | |
| "operations": [ | |
| { | |
| "summary": "List all available jobs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listJobs", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/jobs/{jobDefinitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a job definition ", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JobDefinitionDto", | |
| "parameters": [ | |
| { | |
| "name": "jobDefinitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/jobs/{jobDefinitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Update existing job definition", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JobDefinitionDto", | |
| "parameters": [ | |
| { | |
| "name": "jobDefinitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/jobs/{jobDefinitionId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete job definition", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "jobDefinitionId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/triggers", | |
| "operations": [ | |
| { | |
| "summary": "List all available job triggers", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listTriggers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/scheduler/triggers", | |
| "operations": [ | |
| { | |
| "summary": "Create new job trigger", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createTrigger", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JobTriggerDto", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/scheduler" | |
| } | |
| { | |
| "models": { | |
| "SearchResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchResponse", | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "messages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:ResultMessageSummary", | |
| "properties": { | |
| "highlight_ranges": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "message": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "index": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:DecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "time": { | |
| "type": "integer" | |
| }, | |
| "used_indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "built_query": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchDecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total_results": { | |
| "type": "integer" | |
| }, | |
| "query": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/search/universal/absolute", | |
| "operations": [ | |
| { | |
| "summary": "Message search with absolute timerange.", | |
| "notes": "Search for messages using an absolute timerange, specified as from/to with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.", | |
| "method": "GET", | |
| "nickname": "searchAbsolute", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchResponse", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "from", | |
| "description": "Timerange start. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "to", | |
| "description": "Timerange end. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "Sorting (field:asc / field:desc)", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "decorate", | |
| "description": "Run decorators on search result", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/absolute", | |
| "operations": [ | |
| { | |
| "summary": "Message search with absolute timerange.", | |
| "notes": "Search for messages using an absolute timerange, specified as from/to with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.", | |
| "method": "GET", | |
| "nickname": "searchAbsoluteChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "from", | |
| "description": "Timerange start. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "to", | |
| "description": "Timerange end. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/absolute/export", | |
| "operations": [ | |
| { | |
| "summary": "Export message search with absolute timerange.", | |
| "notes": "Search for messages using an absolute timerange, specified as from/to with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.", | |
| "method": "GET", | |
| "nickname": "exportSearchAbsoluteChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "from", | |
| "description": "Timerange start. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "to", | |
| "description": "Timerange end. See description for date format", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/search/universal/absolute" | |
| } | |
| { | |
| "models": { | |
| "SearchResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchResponse", | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "messages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:ResultMessageSummary", | |
| "properties": { | |
| "highlight_ranges": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "message": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "index": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:DecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "time": { | |
| "type": "integer" | |
| }, | |
| "used_indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "built_query": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchDecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total_results": { | |
| "type": "integer" | |
| }, | |
| "query": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/search/universal/keyword", | |
| "operations": [ | |
| { | |
| "summary": "Message search with keyword as timerange.", | |
| "notes": "Search for messages in a timerange defined by a keyword like \"yesterday\" or \"2 weeks ago to wednesday\".", | |
| "method": "GET", | |
| "nickname": "searchKeyword", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchResponse", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "keyword", | |
| "description": "Range keyword", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "Sorting (field:asc / field:desc)", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "decorate", | |
| "description": "Run decorators on search result", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid keyword provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/keyword", | |
| "operations": [ | |
| { | |
| "summary": "Message search with keyword as timerange.", | |
| "notes": "Search for messages in a timerange defined by a keyword like \"yesterday\" or \"2 weeks ago to wednesday\".", | |
| "method": "GET", | |
| "nickname": "searchKeywordChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "keyword", | |
| "description": "Range keyword", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid keyword provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/keyword/export", | |
| "operations": [ | |
| { | |
| "summary": "Export message search with keyword as timerange.", | |
| "notes": "Search for messages in a timerange defined by a keyword like \"yesterday\" or \"2 weeks ago to wednesday\".", | |
| "method": "GET", | |
| "nickname": "exportSearchKeywordChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "keyword", | |
| "description": "Range keyword", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid keyword provided." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/search/universal/keyword" | |
| } | |
| { | |
| "models": { | |
| "SearchResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchResponse", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "messages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:ResultMessageSummary", | |
| "properties": { | |
| "highlight_ranges": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "message": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "index": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:DecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "time": { | |
| "type": "integer" | |
| }, | |
| "total_results": { | |
| "type": "integer" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:search:responses:SearchDecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "used_indices": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "built_query": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/search/universal/relative", | |
| "operations": [ | |
| { | |
| "summary": "Message search with relative timerange.", | |
| "notes": "Search for messages in a relative timerange, specified as seconds from now. Example: 300 means search from 5 minutes ago to now.", | |
| "method": "GET", | |
| "nickname": "searchRelativeChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "range", | |
| "description": "Relative timeframe to search in. See method description.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/relative", | |
| "operations": [ | |
| { | |
| "summary": "Message search with relative timerange.", | |
| "notes": "Search for messages in a relative timerange, specified as seconds from now. Example: 300 means search from 5 minutes ago to now.", | |
| "method": "GET", | |
| "nickname": "searchRelative", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchResponse", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "range", | |
| "description": "Relative timeframe to search in. See method description.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "Sorting (field:asc / field:desc)", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "decorate", | |
| "description": "Run decorators on search result", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/universal/relative/export", | |
| "operations": [ | |
| { | |
| "summary": "Export message search with relative timerange.", | |
| "notes": "Search for messages in a relative timerange, specified as seconds from now. Example: 300 means search from 5 minutes ago to now.", | |
| "method": "GET", | |
| "nickname": "exportSearchRelativeChunked", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "Query (Lucene syntax)", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "range", | |
| "description": "Relative timeframe to search in. See method description.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of messages to return.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "offset", | |
| "description": "Offset", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "batch_size", | |
| "description": "Batch size for the backend storage export request.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "filter", | |
| "description": "Filter", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "fields", | |
| "description": "Comma separated list of fields to return", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid timerange parameters provided." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/search/universal/relative" | |
| } | |
| { | |
| "models": { | |
| "MessageTokens": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:MessageTokens", | |
| "properties": { | |
| "tokens": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "MessageParseRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:requests:MessageParseRequest", | |
| "properties": { | |
| "message": { | |
| "type": "string" | |
| }, | |
| "codec": { | |
| "type": "string" | |
| }, | |
| "remote_address": { | |
| "type": "string" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/messages/parse", | |
| "operations": [ | |
| { | |
| "summary": "Parse a raw message", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "parse", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ResultMessage", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MessageParseRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Specified codec does not exist." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Could not decode message." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/messages/{index}/analyze", | |
| "operations": [ | |
| { | |
| "summary": "Analyze a message string", | |
| "notes": "Returns what tokens/terms a message string (message or full_message) is split to.", | |
| "method": "GET", | |
| "nickname": "analyze", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MessageTokens", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "The index the message containing the string is stored in.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "analyzer", | |
| "description": "The analyzer to use.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "string", | |
| "description": "The string to analyze.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Specified index does not exist." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/messages/{index}/{messageId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single message.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "search", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ResultMessage", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "The index this message is stored in.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "messageId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Specified index does not exist." | |
| }, | |
| { | |
| "code": 404, | |
| "message": "Message does not exist." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/messages" | |
| } | |
| { | |
| "models": { | |
| "PipelineConnections": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:PipelineConnections", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "pipeline_ids": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "PipelineReverseConnections": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:PipelineReverseConnections", | |
| "properties": { | |
| "pipeline_id": { | |
| "type": "string" | |
| }, | |
| "stream_ids": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/pipelines/connections", | |
| "operations": [ | |
| { | |
| "summary": "Get all pipeline connections", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/connections/to_pipeline", | |
| "operations": [ | |
| { | |
| "summary": "Connect streams to a processing pipeline", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "connectStreams", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Set", | |
| "parameters": [ | |
| { | |
| "name": "Json body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PipelineReverseConnections" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/connections/to_stream", | |
| "operations": [ | |
| { | |
| "summary": "Connect processing pipelines to a stream", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "connectPipelines", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineConnections", | |
| "parameters": [ | |
| { | |
| "name": "Json body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PipelineConnections" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/connections/{streamId}", | |
| "operations": [ | |
| { | |
| "summary": "Get pipeline connections for the given stream", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPipelinesForStream", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineConnections", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/pipelines/connections" | |
| } | |
| { | |
| "models": { | |
| "PipelineSource": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:PipelineSource", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "source": { | |
| "type": "string" | |
| }, | |
| "stages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:StageSource", | |
| "properties": { | |
| "stage": { | |
| "type": "integer" | |
| }, | |
| "match_all": { | |
| "type": "boolean" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "modified_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:parser:errors:ParseError", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "line": { | |
| "type": "integer" | |
| }, | |
| "position_in_line": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/pipelines/pipeline", | |
| "operations": [ | |
| { | |
| "summary": "Create a processing pipeline from source", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createFromParser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineSource", | |
| "parameters": [ | |
| { | |
| "name": "pipeline", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PipelineSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/pipeline", | |
| "operations": [ | |
| { | |
| "summary": "Get all processing pipelines", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/pipeline/parse", | |
| "operations": [ | |
| { | |
| "summary": "Parse a processing pipeline without saving it", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "parse", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineSource", | |
| "parameters": [ | |
| { | |
| "name": "pipeline", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PipelineSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/pipeline/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Get a processing pipeline", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineSource", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/pipeline/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Modify a processing pipeline", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PipelineSource", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "pipeline", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PipelineSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/pipeline/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a processing pipeline", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/pipelines/pipeline" | |
| } | |
| { | |
| "models": { | |
| "RuleSource": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:RuleSource", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "source": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "modified_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:parser:errors:ParseError", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "line": { | |
| "type": "integer" | |
| }, | |
| "position_in_line": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "BulkRuleRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:BulkRuleRequest", | |
| "properties": { | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/pipelines/rule", | |
| "operations": [ | |
| { | |
| "summary": "Create a processing rule from source", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createFromParser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleSource", | |
| "parameters": [ | |
| { | |
| "name": "rule", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RuleSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule", | |
| "operations": [ | |
| { | |
| "summary": "Get all processing rules", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/config/metrics", | |
| "operations": [ | |
| { | |
| "summary": "Update rule metrics configuration", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateMetricsConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleMetricsConfigDto", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/config/metrics", | |
| "operations": [ | |
| { | |
| "summary": "Get rule metrics configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "metricsConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleMetricsConfigDto", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/functions", | |
| "operations": [ | |
| { | |
| "summary": "Get function descriptors", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "functionDescriptors", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/multiple", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the named processing rules in bulk", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "getBulk", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "rules", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "BulkRuleRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/parse", | |
| "operations": [ | |
| { | |
| "summary": "Parse a processing rule without saving it", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "parse", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleSource", | |
| "parameters": [ | |
| { | |
| "name": "rule", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RuleSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Get a processing rule", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleSource", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Modify a processing rule", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RuleSource", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "rule", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RuleSource" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/pipelines/rule/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a processing rule", | |
| "notes": "It can take up to a second until the change is applied", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/pipelines/rule" | |
| } | |
| { | |
| "models": { | |
| "SimulationRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:SimulationRequest", | |
| "properties": { | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "input_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SimulationResponse": { | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:rest:SimulationResponse", | |
| "properties": { | |
| "messages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:ResultMessageSummary", | |
| "properties": { | |
| "highlight_ranges": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "message": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "index": { | |
| "type": "string" | |
| }, | |
| "decoration_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:messages:responses:DecorationStats", | |
| "properties": { | |
| "added_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "changed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "removed_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "simulation_trace": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:pipelineprocessor:simulator:PipelineInterpreterTrace", | |
| "properties": { | |
| "time": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "took_microseconds": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/pipelines/simulate", | |
| "operations": [ | |
| { | |
| "summary": "Simulate the execution of the pipeline message processor", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "simulate", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SimulationResponse", | |
| "parameters": [ | |
| { | |
| "name": "simulation", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "SimulationRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/pipelines/simulate" | |
| } | |
| { | |
| "models": { | |
| "RegionsResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:RegionsResponse", | |
| "properties": { | |
| "regions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:AWSRegion", | |
| "properties": { | |
| "value": { | |
| "type": "string" | |
| }, | |
| "label": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "LogGroupsResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:LogGroupsResponse", | |
| "properties": { | |
| "log_groups": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "KinesisPermissionsResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:KinesisPermissionsResponse", | |
| "properties": { | |
| "setup_policy": { | |
| "type": "string" | |
| }, | |
| "auto_setup_policy": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "StreamsResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:StreamsResponse", | |
| "properties": { | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AvailableServiceResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:AvailableServiceResponse", | |
| "properties": { | |
| "services": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:AvailableService", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "policy": { | |
| "type": "string" | |
| }, | |
| "helper_text": { | |
| "type": "string" | |
| }, | |
| "learn_more_link": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/available_services", | |
| "operations": [ | |
| { | |
| "summary": "Get all available AWS services", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAvailableServices", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AvailableServiceResponse", | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "An error occurred encoding the policy JSON" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/cloudwatch/log_groups", | |
| "operations": [ | |
| { | |
| "summary": "Get all available AWS CloudWatch log groups names for the specified region.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "getLogGroupNames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LogGroupsResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AWSRequestImpl" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/inputs", | |
| "operations": [ | |
| { | |
| "summary": "Create a new AWS input.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AWSInputCreateRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/kinesis/health_check", | |
| "operations": [ | |
| { | |
| "summary": "Attempt to retrieve logs from the indicated AWS log group with the specified credentials.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "kinesisHealthCheck", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "KinesisHealthCheckRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/kinesis/streams", | |
| "operations": [ | |
| { | |
| "summary": "Get all available Kinesis streams for the specified region.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "getKinesisStreams", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamsResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AWSRequestImpl" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/permissions", | |
| "operations": [ | |
| { | |
| "summary": "Get the permissions required for the AWS Kinesis setup and for the Kinesis auto-setup.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "KinesisPermissionsResponse", | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "An error occurred encoding the policy JSON" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/regions", | |
| "operations": [ | |
| { | |
| "summary": "Get all available AWS regions", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAwsRegions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RegionsResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.integrations/aws" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.aws/config", | |
| "operations": [ | |
| { | |
| "summary": "Updates the AWS default configuration.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.aws/config" | |
| } | |
| { | |
| "models": { | |
| "CreateRolePermissionResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:CreateRolePermissionResponse", | |
| "properties": { | |
| "result": { | |
| "type": "string" | |
| }, | |
| "role_arn": { | |
| "type": "string" | |
| }, | |
| "role_name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CreateLogSubscriptionResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:CreateLogSubscriptionResponse", | |
| "properties": { | |
| "result": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "KinesisNewStreamResponse": { | |
| "id": "urn:jsonschema:org:graylog:integrations:aws:resources:responses:KinesisNewStreamResponse", | |
| "properties": { | |
| "stream_name": { | |
| "type": "string" | |
| }, | |
| "stream_arn": { | |
| "type": "string" | |
| }, | |
| "result": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/kinesis/auto_setup/create_stream", | |
| "operations": [ | |
| { | |
| "summary": "Step 1: Attempt to create a new kinesis stream and wait for it to be ready.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createNewKinesisStream", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "KinesisNewStreamResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "KinesisNewStreamRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/kinesis/auto_setup/create_subscription", | |
| "operations": [ | |
| { | |
| "summary": "Step 3: Subscribe a Kinesis stream to a CloudWatch log group", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createSubscription", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CreateLogSubscriptionResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CreateLogSubscriptionRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.integrations/aws/kinesis/auto_setup/create_subscription_policy", | |
| "operations": [ | |
| { | |
| "summary": "Step 2: Create AWS IAM policy needed for CloudWatch to write logs to Kinesis", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "autoKinesisPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CreateRolePermissionResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CreateRolePermissionRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.integrations/aws/kinesis/auto_setup" | |
| } | |
| { | |
| "models": { | |
| "Availability": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:Availability", | |
| "properties": { | |
| "available": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "IndexArchiveMetadata": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveMetadata", | |
| "properties": { | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "index_size": { | |
| "type": "integer" | |
| }, | |
| "index_shard_count": { | |
| "type": "integer" | |
| }, | |
| "archive_id": { | |
| "type": "string" | |
| }, | |
| "histogram_bucket_size": { | |
| "type": "integer" | |
| }, | |
| "timestamp_min": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "timestamp_max": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "stream_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "id_mappings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IdMappings", | |
| "properties": { | |
| "streams": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "inputs": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "nodes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "document_count": { | |
| "type": "integer" | |
| }, | |
| "creation_duration": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "segments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveSegment", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "raw_size": { | |
| "type": "integer" | |
| }, | |
| "compression_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "GZIP", | |
| "SNAPPY", | |
| "LZ4", | |
| "ZSTD" | |
| ] | |
| }, | |
| "checksum": { | |
| "type": "string" | |
| }, | |
| "checksum_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "CRC32", | |
| "MD5", | |
| "SHA1", | |
| "SHA256" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ArchiveIndexJobSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:ArchiveIndexJobSummary", | |
| "properties": { | |
| "archive_job_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:config:ArchiveConfig", | |
| "properties": { | |
| "max_segment_size": { | |
| "type": "integer" | |
| }, | |
| "backend_id": { | |
| "type": "string" | |
| }, | |
| "histogram_bucket_size": { | |
| "type": "integer" | |
| }, | |
| "archive_path": { | |
| "type": "string" | |
| }, | |
| "restore_index_batch_size": { | |
| "type": "integer" | |
| }, | |
| "excluded_streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "metadata_filename": { | |
| "type": "string" | |
| }, | |
| "segment_compression_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "GZIP", | |
| "SNAPPY", | |
| "LZ4", | |
| "ZSTD" | |
| ] | |
| }, | |
| "segment_checksum_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "CRC32", | |
| "MD5", | |
| "SHA1", | |
| "SHA256" | |
| ] | |
| }, | |
| "segment_filename_prefix": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "system_job": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:SystemJobSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "percent_complete": { | |
| "type": "integer" | |
| }, | |
| "is_cancelable": { | |
| "type": "boolean" | |
| }, | |
| "provides_progress": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ArchiveRestoreJobSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:ArchiveRestoreJobSummary", | |
| "properties": { | |
| "archive_metadata": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveMetadata", | |
| "properties": { | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "index_size": { | |
| "type": "integer" | |
| }, | |
| "index_shard_count": { | |
| "type": "integer" | |
| }, | |
| "archive_id": { | |
| "type": "string" | |
| }, | |
| "histogram_bucket_size": { | |
| "type": "integer" | |
| }, | |
| "timestamp_min": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "timestamp_max": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "stream_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "id_mappings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IdMappings", | |
| "properties": { | |
| "streams": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "inputs": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "nodes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "document_count": { | |
| "type": "integer" | |
| }, | |
| "creation_duration": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "segments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveSegment", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "raw_size": { | |
| "type": "integer" | |
| }, | |
| "compression_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "GZIP", | |
| "SNAPPY", | |
| "LZ4", | |
| "ZSTD" | |
| ] | |
| }, | |
| "checksum": { | |
| "type": "string" | |
| }, | |
| "checksum_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "CRC32", | |
| "MD5", | |
| "SHA1", | |
| "SHA256" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "system_job": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:SystemJobSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "percent_complete": { | |
| "type": "integer" | |
| }, | |
| "is_cancelable": { | |
| "type": "boolean" | |
| }, | |
| "provides_progress": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "IndexArchivesSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:IndexArchivesSummary", | |
| "properties": { | |
| "archives_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:IndexArchiveContext", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "archive_id": { | |
| "type": "string" | |
| }, | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "restored": { | |
| "type": "boolean" | |
| }, | |
| "restored_index_name": { | |
| "type": "string" | |
| }, | |
| "backend_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "archives": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveMetadata", | |
| "properties": { | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "index_size": { | |
| "type": "integer" | |
| }, | |
| "index_shard_count": { | |
| "type": "integer" | |
| }, | |
| "archive_id": { | |
| "type": "string" | |
| }, | |
| "histogram_bucket_size": { | |
| "type": "integer" | |
| }, | |
| "timestamp_min": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "timestamp_max": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "source_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "stream_histogram": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "id_mappings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IdMappings", | |
| "properties": { | |
| "streams": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "inputs": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "nodes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "document_count": { | |
| "type": "integer" | |
| }, | |
| "creation_duration": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "segments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:metadata:IndexArchiveSegment", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "raw_size": { | |
| "type": "integer" | |
| }, | |
| "compression_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "GZIP", | |
| "SNAPPY", | |
| "LZ4", | |
| "ZSTD" | |
| ] | |
| }, | |
| "checksum": { | |
| "type": "string" | |
| }, | |
| "checksum_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "CRC32", | |
| "MD5", | |
| "SHA1", | |
| "SHA256" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ArchiveRebuildJobSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchivesResource:ArchiveRebuildJobSummary", | |
| "properties": { | |
| "system_job": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:SystemJobSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "percent_complete": { | |
| "type": "integer" | |
| }, | |
| "is_cancelable": { | |
| "type": "boolean" | |
| }, | |
| "provides_progress": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives", | |
| "operations": [ | |
| { | |
| "summary": "Returns all existing archives", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexArchivesSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/backend/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns all existing archives for the given backend", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "allForBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexArchivesSummary", | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/backend/{backendId}/{archiveId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the archive for the given backend and archive id", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteByBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexArchiveMetadata", | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/backend/{backendId}/{archiveId}/restore", | |
| "operations": [ | |
| { | |
| "summary": "Restore the given archive", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "restoreFromBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveRestoreJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/catalog", | |
| "operations": [ | |
| { | |
| "summary": "Returns the matching archives from the catalog", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "catalog", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CatalogPage", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "created_at", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "desc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/catalog/export/{exportType}", | |
| "operations": [ | |
| { | |
| "summary": "Exports a list of certain archive attributes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "exportFilenames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Response", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "10000", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "created_at", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "exportType", | |
| "description": "The attribute to be exported", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": "filename", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/catalog/rebuild", | |
| "operations": [ | |
| { | |
| "summary": "Rebuild the archive catalog from disk", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "rebuild", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveRebuildJobSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/catalog/{entryId}/available", | |
| "operations": [ | |
| { | |
| "summary": "Check the on-disk availability of the given catalog entry", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "checkAvailability", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Availability", | |
| "parameters": [ | |
| { | |
| "name": "entryId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/{archiveId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the archive for the given id", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexArchiveMetadata", | |
| "parameters": [ | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/{archiveId}/restore", | |
| "operations": [ | |
| { | |
| "summary": "Restore the given archive", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "restore", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveRestoreJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/archives/{indexName}", | |
| "operations": [ | |
| { | |
| "summary": "Archive the given index", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "run", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveIndexJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "indexName", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "index_action", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "NONE", | |
| "type": "IndexAction" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Archive job for given index already running" | |
| }, | |
| { | |
| "code": 402, | |
| "message": "Not archiving index because license is invalid" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.archive/archives" | |
| } | |
| { | |
| "models": { | |
| "BackendPage": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchiveBackendsResource:BackendPage", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "backends": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:backends:ArchiveBackendConfig", | |
| "properties": { | |
| "settings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:backends:ArchiveBackendSettingsDTO" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "OutputTemplateTestResult": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:rest:ArchiveBackendsResource:OutputTemplateTestResult", | |
| "properties": { | |
| "template": { | |
| "type": "string" | |
| }, | |
| "result": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ArchiveBackendConfig": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:backends:ArchiveBackendConfig", | |
| "properties": { | |
| "settings": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:backends:ArchiveBackendSettingsDTO" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends", | |
| "operations": [ | |
| { | |
| "summary": "Create new backend config", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveBackendConfig", | |
| "parameters": [ | |
| { | |
| "name": "config", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ArchiveBackendConfig" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends", | |
| "operations": [ | |
| { | |
| "summary": "Get backend configurations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfigs", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "BackendPage", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "created_at", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends/test-output-template", | |
| "operations": [ | |
| { | |
| "summary": "Test if given output template string is valid", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "testOutputTemplate", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OutputTemplateTestResult", | |
| "parameters": [ | |
| { | |
| "name": "template", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Get backend configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveBackendConfig", | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Update backend config", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveBackendConfig", | |
| "parameters": [ | |
| { | |
| "name": "config", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ArchiveBackendConfig" | |
| }, | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/backends/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete backend configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveBackendConfig", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "delete_archives", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.archive/backends" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives", | |
| "operations": [ | |
| { | |
| "summary": "Returns all existing archives", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/backend/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns all existing archives for the given backend", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "allForBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/backend/{backendId}/{archiveId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the archive for the given backend and archive id", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteByBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/backend/{backendId}/{archiveId}/restore", | |
| "operations": [ | |
| { | |
| "summary": "Restore the given archive", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "restoreFromBackend", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/catalog", | |
| "operations": [ | |
| { | |
| "summary": "Returns the matching archives from the catalog", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "catalog", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "created_at", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "desc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/catalog/export/{exportType}", | |
| "operations": [ | |
| { | |
| "summary": "Exports a list of certain archive attributes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "exportFilenames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "10000", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "created_at", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "exportType", | |
| "description": "The attribute to be exported", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": "filename", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/catalog/rebuild", | |
| "operations": [ | |
| { | |
| "summary": "Rebuild the archive catalog from disk", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "rebuild", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/catalog/{entryId}/available", | |
| "operations": [ | |
| { | |
| "summary": "Check the on-disk availability of the given catalog entry", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "checkAvailability", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "entryId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/{archiveId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the archive for the given id", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/{archiveId}/restore", | |
| "operations": [ | |
| { | |
| "summary": "Restore the given archive", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "restore", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "archiveId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/cluster/archives/{indexName}", | |
| "operations": [ | |
| { | |
| "summary": "Archive the given index", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "run", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "indexName", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "index_action", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "NONE", | |
| "type": "IndexAction" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Archive job for given index already running" | |
| }, | |
| { | |
| "code": 402, | |
| "message": "Not archiving index because license is invalid" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.archive/cluster/archives" | |
| } | |
| { | |
| "models": { | |
| "ArchiveConfig": { | |
| "id": "urn:jsonschema:org:graylog:plugins:archive:config:ArchiveConfig", | |
| "properties": { | |
| "max_segment_size": { | |
| "type": "integer" | |
| }, | |
| "backend_id": { | |
| "type": "string" | |
| }, | |
| "histogram_bucket_size": { | |
| "type": "integer" | |
| }, | |
| "archive_path": { | |
| "type": "string" | |
| }, | |
| "restore_index_batch_size": { | |
| "type": "integer" | |
| }, | |
| "excluded_streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "metadata_filename": { | |
| "type": "string" | |
| }, | |
| "segment_compression_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "GZIP", | |
| "SNAPPY", | |
| "LZ4", | |
| "ZSTD" | |
| ] | |
| }, | |
| "segment_checksum_type": { | |
| "type": "string", | |
| "enum": [ | |
| "NONE", | |
| "CRC32", | |
| "MD5", | |
| "SHA1", | |
| "SHA256" | |
| ] | |
| }, | |
| "segment_filename_prefix": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/config", | |
| "operations": [ | |
| { | |
| "summary": "Get archive configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveConfig", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.archive/config", | |
| "operations": [ | |
| { | |
| "summary": "Update archive configuration", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ArchiveConfig", | |
| "parameters": [ | |
| { | |
| "name": "config", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ArchiveConfig" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.archive/config" | |
| } | |
| { | |
| "models": { | |
| "SearchQueryRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:auditlog:rest:dto:SearchQueryRequest", | |
| "properties": { | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "query": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AuditLogEntriesSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:auditlog:rest:dto:AuditLogEntriesSummary", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "perPage": { | |
| "type": "integer" | |
| }, | |
| "entries": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:auditlog:common:AuditLogEntryView", | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| }, | |
| "actor": { | |
| "type": "string" | |
| }, | |
| "actor_formatted": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "message_template": { | |
| "type": "string" | |
| }, | |
| "namespace": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "type": "string" | |
| }, | |
| "success_status": { | |
| "type": "string", | |
| "enum": [ | |
| "SUCCESS", | |
| "FAILURE" | |
| ] | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| }, | |
| "query": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/entries", | |
| "operations": [ | |
| { | |
| "summary": "Get audit log entries", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "entries", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AuditLogEntriesSummary", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/entries", | |
| "operations": [ | |
| { | |
| "summary": "Search audit log entries", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "search", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AuditLogEntriesSummary", | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "SearchQueryRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/entries/export/csv", | |
| "operations": [ | |
| { | |
| "summary": "Export audit log entries as CSV", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "exportCsv", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/entries/export/json", | |
| "operations": [ | |
| { | |
| "summary": "Export audit log entries as JSON", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "exportJson", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.auditlog/entries" | |
| } | |
| { | |
| "models": { | |
| "AuditLogStatusSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:auditlog:rest:AuditLogStatusSummary", | |
| "properties": { | |
| "mongodb_collection_name": { | |
| "type": "string" | |
| }, | |
| "log4j_enabled": { | |
| "type": "boolean" | |
| }, | |
| "log4j_logger_name": { | |
| "type": "string" | |
| }, | |
| "log4j_marker_name": { | |
| "type": "string" | |
| }, | |
| "message_signing_enabled": { | |
| "type": "boolean" | |
| }, | |
| "log4j_appender_config": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/status", | |
| "operations": [ | |
| { | |
| "summary": "Get audit log status", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "status", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "AuditLogStatusSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.auditlog/status/all", | |
| "operations": [ | |
| { | |
| "summary": "Get audit log status of all nodes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "statusAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.auditlog/status" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/authz/roles/{roleId}/teams", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of teams for a role", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getUsersForRole", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/authz/roles/{roleId}/teams/add", | |
| "operations": [ | |
| { | |
| "summary": "Assign a role to many teams", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "addRoleToTeams", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "teamIds", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Set" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/authz/roles/{roleId}/teams/remove", | |
| "operations": [ | |
| { | |
| "summary": "Remove a role from a team", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "removeRoleFromTeam", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "roleId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.security/authz/roles" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations", | |
| "operations": [ | |
| { | |
| "summary": "Create new collector configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorConfiguration", | |
| "parameters": [ | |
| { | |
| "name": "createDefaults", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "RestBoolean" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorConfiguration" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations", | |
| "operations": [ | |
| { | |
| "summary": "List all collector configurations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listConfigurations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorConfigurationListResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/tags", | |
| "operations": [ | |
| { | |
| "summary": "List all used tags", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getTags", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Show collector configuration details", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfigurations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorConfiguration", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a collector configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/inputs", | |
| "operations": [ | |
| { | |
| "summary": "Create a configuration input", | |
| "notes": "This is a stateless method which inserts a collector input", | |
| "method": "POST", | |
| "nickname": "createInput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorInput" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/inputs/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete input form configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteInput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Input not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/inputs/{inputId}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a configuration input", | |
| "notes": "This is a stateless method which copies a collector input to one with another name", | |
| "method": "POST", | |
| "nickname": "copyInput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Input not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/inputs/{input_id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a configuration input", | |
| "notes": "This is a stateless method which updates a collector input", | |
| "method": "PUT", | |
| "nickname": "updateInput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "input_id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorInput" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/name", | |
| "operations": [ | |
| { | |
| "summary": "Updates a collector configuration name", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfigurationName", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorConfiguration", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorConfiguration" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/outputs", | |
| "operations": [ | |
| { | |
| "summary": "Create a configuration output", | |
| "notes": "This is a stateless method which inserts a collector output", | |
| "method": "POST", | |
| "nickname": "createOutput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorOutput" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/outputs/{outputId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete output from configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteOutput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Output not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| }, | |
| { | |
| "code": 412, | |
| "message": "Still inputs assigned to output" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/outputs/{outputId}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a configuration output", | |
| "notes": "This is a stateless method which copies a collector output to one with another name", | |
| "method": "POST", | |
| "nickname": "copyOutput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Output not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/outputs/{output_id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a configuration output", | |
| "notes": "This is a stateless method which updates a collector output", | |
| "method": "PUT", | |
| "nickname": "updateOutput", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "output_id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorOutput" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/snippets", | |
| "operations": [ | |
| { | |
| "summary": "Create a configuration snippet", | |
| "notes": "This is a stateless method which inserts a collector configuration snippet", | |
| "method": "POST", | |
| "nickname": "createSnippet", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorConfigurationSnippet" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/snippets/{snippetId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete snippet from configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteSnippet", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Snippet not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/snippets/{snippetId}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a configuration snippet", | |
| "notes": "This is a stateless method which copies a collector snippet to one with another name", | |
| "method": "POST", | |
| "nickname": "copySnippet", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration or Snippet not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/snippets/{snippet_id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a configuration snippet", | |
| "notes": "This is a stateless method which updates a collector snippet", | |
| "method": "PUT", | |
| "nickname": "updateSnippet", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "snippet_id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorConfigurationSnippet" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/configurations/{id}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a configuration", | |
| "notes": "This is a stateless method which copies a collector configuration to one with another name", | |
| "method": "POST", | |
| "nickname": "copyConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Configuration not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/{collectorId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single collector configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "tags", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Collector not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| }, | |
| { | |
| "code": 304, | |
| "message": "Configuration didn't update." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.collector" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "MongoDBDataAdapterEntry": { | |
| "id": "urn:jsonschema:org:graylog:plugins:lookup:dto:MongoDBDataAdapterEntry", | |
| "properties": { | |
| "values": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "key": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "data_adapter_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/stats/{adapterId}", | |
| "operations": [ | |
| { | |
| "summary": "Get stats for data adapter", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "stats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MongoDBDataAdapterStats", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/{adapterId}", | |
| "operations": [ | |
| { | |
| "summary": "List all entries of a MongoDB data adapter", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "key", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/{adapterId}", | |
| "operations": [ | |
| { | |
| "summary": "Create a MongoDB lookup entry", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MongoDBDataAdapterEntry", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MongoDBDataAdapterEntry" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid MongoDB data adapter payload." | |
| }, | |
| { | |
| "code": 402, | |
| "message": "No valid license found" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/{adapterId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete all entries for this MongoDB data adapter", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteAllByDataAdapterId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Entry not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/{adapterId}/{entryId}", | |
| "operations": [ | |
| { | |
| "summary": "Update a MongoDB lookup entry", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MongoDBDataAdapterEntry", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "entryId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MongoDBDataAdapterEntry" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid MongoDB data adapter payload." | |
| }, | |
| { | |
| "code": 402, | |
| "message": "No valid license found" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb/{adapterId}/{entryId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a MongoDB data adapter entry", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "adapterId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "entryId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Entry not found." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.lookup/lookup/adapters/mongodb" | |
| } | |
| { | |
| "models": { | |
| "O365SubscriptionRequest": { | |
| "id": "urn:jsonschema:org:graylog:enterprise:integrations:office365:api:O365SubscriptionRequest", | |
| "properties": { | |
| "o365_tenant_id": { | |
| "type": "string" | |
| }, | |
| "o365_client_id": { | |
| "type": "string" | |
| }, | |
| "o365_client_secret": { | |
| "type": "string" | |
| }, | |
| "o365_endpoint": { | |
| "type": "string", | |
| "enum": [ | |
| "ENTERPRISE", | |
| "GCC_HIGH", | |
| "DOD" | |
| ] | |
| }, | |
| "o365_azuread_records": { | |
| "type": "boolean" | |
| }, | |
| "o365_exchange_records": { | |
| "type": "boolean" | |
| }, | |
| "o365_dlpall_records": { | |
| "type": "boolean" | |
| }, | |
| "o365_general_records": { | |
| "type": "boolean" | |
| }, | |
| "o365_sharepoint_records": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "O365CreateInputRequest": { | |
| "id": "urn:jsonschema:org:graylog:enterprise:integrations:office365:api:requests:O365CreateInputRequest", | |
| "properties": { | |
| "store_full_message": { | |
| "type": "boolean" | |
| }, | |
| "content_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "endpoint_type": { | |
| "type": "string", | |
| "enum": [ | |
| "ENTERPRISE", | |
| "GCC_HIGH", | |
| "DOD" | |
| ] | |
| }, | |
| "enable_throttling": { | |
| "type": "boolean" | |
| }, | |
| "polling_interval": { | |
| "type": "integer" | |
| }, | |
| "polling_time_unit": { | |
| "type": "string", | |
| "enum": [ | |
| "NANOSECONDS", | |
| "MICROSECONDS", | |
| "MILLISECONDS", | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "o365_client_id": { | |
| "type": "string" | |
| }, | |
| "o365_client_secret": { | |
| "type": "string" | |
| }, | |
| "o365_tenant_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "O365RequestImpl": { | |
| "id": "urn:jsonschema:org:graylog:enterprise:integrations:office365:api:requests:O365RequestImpl", | |
| "properties": { | |
| "o365_endpoint": { | |
| "type": "string", | |
| "enum": [ | |
| "ENTERPRISE", | |
| "GCC_HIGH", | |
| "DOD" | |
| ] | |
| }, | |
| "o365_client_id": { | |
| "type": "string" | |
| }, | |
| "o365_client_secret": { | |
| "type": "string" | |
| }, | |
| "o365_tenant_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.enterprise.integrations/office365/checkSubscriptions", | |
| "operations": [ | |
| { | |
| "summary": "Check available subscriptions", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "checkSubscriptions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "O365RequestImpl" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.enterprise.integrations/office365/inputs", | |
| "operations": [ | |
| { | |
| "summary": "Create a new O365 input", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "O365CreateInputRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.enterprise.integrations/office365/startSubscription", | |
| "operations": [ | |
| { | |
| "summary": "Start selected subscriptions", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "startSubscription", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "O365SubscriptionRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.enterprise.integrations/office365" | |
| } | |
| { | |
| "models": { | |
| "ReportResponse": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:responses:ReportResponse", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "subtitle": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "widgets": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:responses:ReportDashboardWidget", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "dashboard_id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "cache_time": { | |
| "type": "integer" | |
| }, | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:BackendQuery" | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:views:WidgetConfigDTO" | |
| } | |
| } | |
| } | |
| }, | |
| "positions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportWidgetPosition", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "col": { | |
| "type": "integer" | |
| }, | |
| "row": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "scheduling": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportScheduling", | |
| "properties": { | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "frequency_configuration": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportFrequencyConfiguration", | |
| "properties": { | |
| "time": { | |
| "type": "string" | |
| }, | |
| "day_of_week": { | |
| "type": "string" | |
| }, | |
| "day_of_month": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "next_execution": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "email_subject": { | |
| "type": "string" | |
| }, | |
| "email_body": { | |
| "type": "string" | |
| }, | |
| "user_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "email_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "parameter_values": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "optional": { | |
| "type": "boolean" | |
| }, | |
| "binding": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "default_value": { | |
| "type": "any" | |
| }, | |
| "data_type": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ReportRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "subtitle": { | |
| "type": "string" | |
| }, | |
| "logo": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "widgets": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "positions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportWidgetPosition", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "col": { | |
| "type": "integer" | |
| }, | |
| "row": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "scheduling": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportScheduling", | |
| "properties": { | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "frequency_configuration": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportFrequencyConfiguration", | |
| "properties": { | |
| "time": { | |
| "type": "string" | |
| }, | |
| "day_of_week": { | |
| "type": "string" | |
| }, | |
| "day_of_month": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "next_execution": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "email_subject": { | |
| "type": "string" | |
| }, | |
| "email_body": { | |
| "type": "string" | |
| }, | |
| "user_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "email_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "parameter_values": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ReportPositionsRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportPositionsRequest", | |
| "properties": { | |
| "positions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportWidgetPosition", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "col": { | |
| "type": "integer" | |
| }, | |
| "row": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ReportHistoryList": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:responses:ReportHistoryList", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "history": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:responses:ReportHistorySummary", | |
| "properties": { | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "SUCCESS", | |
| "FAILURE" | |
| ] | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "generated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ReportList": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:responses:ReportList", | |
| "properties": { | |
| "reports": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportConfiguration", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "subtitle": { | |
| "type": "string" | |
| }, | |
| "logo": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "widgets": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportWidget", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "dashboard_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "positions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:api:ReportWidgetPosition", | |
| "properties": { | |
| "dashboard_widget_id": { | |
| "type": "string" | |
| }, | |
| "col": { | |
| "type": "integer" | |
| }, | |
| "row": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "scheduling": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportScheduling", | |
| "properties": { | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "frequency_configuration": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportFrequencyConfiguration", | |
| "properties": { | |
| "time": { | |
| "type": "string" | |
| }, | |
| "day_of_week": { | |
| "type": "string" | |
| }, | |
| "day_of_month": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "next_execution": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "email_subject": { | |
| "type": "string" | |
| }, | |
| "email_body": { | |
| "type": "string" | |
| }, | |
| "user_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "email_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "parameter_values": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "index": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ReportSchedulingRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportSchedulingRequest", | |
| "properties": { | |
| "scheduling": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportScheduling", | |
| "properties": { | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "frequency": { | |
| "type": "string" | |
| }, | |
| "frequency_configuration": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:report:rest:requests:ReportFrequencyConfiguration", | |
| "properties": { | |
| "time": { | |
| "type": "string" | |
| }, | |
| "day_of_week": { | |
| "type": "string" | |
| }, | |
| "day_of_month": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "next_execution": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "email_subject": { | |
| "type": "string" | |
| }, | |
| "email_body": { | |
| "type": "string" | |
| }, | |
| "user_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "email_receivers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports", | |
| "operations": [ | |
| { | |
| "summary": "Create a report.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ReportRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Logo data URL is not valid." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Logo is too large." | |
| }, | |
| { | |
| "code": 402, | |
| "message": "No valid license found" | |
| }, | |
| { | |
| "code": 404, | |
| "message": "One or more widgets not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports", | |
| "operations": [ | |
| { | |
| "summary": "List all reports.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single report.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportResponse", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Report not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}", | |
| "operations": [ | |
| { | |
| "summary": "Update a report.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportResponse", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ReportRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Report not found." | |
| }, | |
| { | |
| "code": 404, | |
| "message": "One or more widgets not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a report and all its widgets.", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Report not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/email", | |
| "operations": [ | |
| { | |
| "summary": "Send report PDF as email", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "sendReport", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 402, | |
| "message": "No valid license found" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/generate", | |
| "operations": [ | |
| { | |
| "summary": "Download a report instantly.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "generateReport", | |
| "produces": [ | |
| "application/pdf" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Report not found." | |
| }, | |
| { | |
| "code": 412, | |
| "message": "Service temporally unavailable." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/history", | |
| "operations": [ | |
| { | |
| "summary": "Get a history of generated reports", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "history", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportHistoryList", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "skip", | |
| "description": "The number of elements to skip (offset).", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "0", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "The maximum number of elements to return.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "100", | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/logo", | |
| "operations": [ | |
| { | |
| "summary": "Get a report's logo.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getLogo", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Report not found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/positions", | |
| "operations": [ | |
| { | |
| "summary": "Update widget positions of a report.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updatePositions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportResponse", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ReportPositionsRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/reports/{reportId}/scheduling", | |
| "operations": [ | |
| { | |
| "summary": "Update report scheduling.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateScheduling", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReportResponse", | |
| "parameters": [ | |
| { | |
| "name": "reportId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ReportSchedulingRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.report/reports" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.report/widgets", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all dashboards and their widgets", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.report/widgets" | |
| } | |
| { | |
| "models": { | |
| "CollectorRegistrationRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:requests:CollectorRegistrationRequest", | |
| "properties": { | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_details": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorNodeDetailsSummary", | |
| "properties": { | |
| "operating_system": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "metrics": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorMetrics", | |
| "properties": { | |
| "disks_75": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cpu_idle": { | |
| "type": "number" | |
| }, | |
| "load_1": { | |
| "type": "number" | |
| } | |
| } | |
| }, | |
| "log_file_list": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorLogFile", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "mod_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "is_dir": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatusList", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "backends": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatus", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CollectorUpload": { | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:CollectorUpload", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "collector_name": { | |
| "type": "string" | |
| }, | |
| "rendered_configuration": { | |
| "type": "string" | |
| }, | |
| "created": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "CollectorSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:responses:CollectorSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_details": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorNodeDetailsSummary", | |
| "properties": { | |
| "operating_system": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "metrics": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorMetrics", | |
| "properties": { | |
| "disks_75": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cpu_idle": { | |
| "type": "number" | |
| }, | |
| "load_1": { | |
| "type": "number" | |
| } | |
| } | |
| }, | |
| "log_file_list": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorLogFile", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "mod_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "is_dir": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatusList", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "backends": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatus", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "last_seen": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "collector_version": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "CollectorList": { | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:responses:CollectorList", | |
| "properties": { | |
| "collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:responses:CollectorSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_details": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorNodeDetailsSummary", | |
| "properties": { | |
| "operating_system": { | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "metrics": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorMetrics", | |
| "properties": { | |
| "disks_75": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cpu_idle": { | |
| "type": "number" | |
| }, | |
| "load_1": { | |
| "type": "number" | |
| } | |
| } | |
| }, | |
| "log_file_list": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorLogFile", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "mod_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "is_dir": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatusList", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "backends": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:collector:collectors:rest:models:CollectorStatus", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "last_seen": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "collector_version": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors", | |
| "operations": [ | |
| { | |
| "summary": "Lists all existing collector registrations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors/{collectorId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns at most one collector summary for the specified collector id", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorSummary", | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No collector with the specified id exists" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors/{collectorId}", | |
| "operations": [ | |
| { | |
| "summary": "Create/update a collector registration", | |
| "notes": "This is a stateless method which upserts a collector registration", | |
| "method": "PUT", | |
| "nickname": "register", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "The collector id this collector is registering as.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorRegistrationRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors/{collectorId}/action", | |
| "operations": [ | |
| { | |
| "summary": "Returns queued actions for the specified collector id", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAction", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No actions found for specified id" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors/{collectorId}/action", | |
| "operations": [ | |
| { | |
| "summary": "Set a collector action", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "setAction", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "The collector id this collector is registering as.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "List" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied action is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.collector/collectors/{collectorId}/configuration", | |
| "operations": [ | |
| { | |
| "summary": "Pass back rendered collector configuratin", | |
| "notes": "This method uploads a collector configuration", | |
| "method": "PUT", | |
| "nickname": "upload", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "collectorId", | |
| "description": "The collector id this collector is registering as.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CollectorUpload" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.collector/collectors" | |
| } | |
| { | |
| "models": { | |
| "License": { | |
| "id": "urn:jsonschema:org:graylog:plugins:license:api:License", | |
| "properties": { | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "subject": { | |
| "type": "string" | |
| }, | |
| "trial": { | |
| "type": "boolean" | |
| }, | |
| "expired": { | |
| "type": "boolean" | |
| }, | |
| "enterprise": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:license:api:LicenseEnterprise", | |
| "properties": { | |
| "require_remote_check": { | |
| "type": "boolean" | |
| }, | |
| "number_of_nodes": { | |
| "type": "integer" | |
| }, | |
| "cluster_ids": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "allowed_remote_check_failures": { | |
| "type": "integer" | |
| }, | |
| "traffic_limit": { | |
| "type": "integer" | |
| }, | |
| "traffic_check_range": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "allowed_traffic_violations": { | |
| "type": "integer" | |
| }, | |
| "expiration_warning_range": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "audience": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:license:api:Licensee", | |
| "properties": { | |
| "company": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "expiration_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "issue_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "not_before_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "version": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses", | |
| "operations": [ | |
| { | |
| "summary": "Show all installed licenses", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showLicenses", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses", | |
| "operations": [ | |
| { | |
| "summary": "Install new license", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "uploadLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "License", | |
| "parameters": [ | |
| { | |
| "name": "license", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses/status", | |
| "operations": [ | |
| { | |
| "summary": "Show status for all installed licenses", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LicenseStatusResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses/status/for-subject", | |
| "operations": [ | |
| { | |
| "summary": "Get license status for given subject", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "statusForSubject", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "subject", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses/verify", | |
| "operations": [ | |
| { | |
| "summary": "Verify a license without saving", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "verifyLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "VerificationResult", | |
| "parameters": [ | |
| { | |
| "name": "license", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses/{licenseId}", | |
| "operations": [ | |
| { | |
| "summary": "Show license with given ID", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "License", | |
| "parameters": [ | |
| { | |
| "name": "licenseId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.license/licenses/{licenseId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete license with given ID", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "licenseId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.license/licenses" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.security/team-sync/services/authServiceId/backend" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/team-sync/trigger/{authServiceId}", | |
| "operations": [ | |
| { | |
| "summary": "Trigger team sync for the given authentication service backend", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "triggerSync", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "authServiceId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.security/team-sync" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/team-sync/test/backend", | |
| "operations": [ | |
| { | |
| "summary": "Test team-sync backend configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "test", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "TeamSyncTestBackendRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.security/team-sync/test" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams", | |
| "operations": [ | |
| { | |
| "summary": "Create a new team", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "TeamDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of all teams", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getList", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/member/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of teams containing a user", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getListForUsername", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/shares/{teamId}", | |
| "operations": [ | |
| { | |
| "summary": "Return shares for a team", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "pagination parameters", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PaginationParameters" | |
| }, | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "capability", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "entity_type", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single team", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "TeamDTO", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}", | |
| "operations": [ | |
| { | |
| "summary": "Update a team", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "TeamDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a team", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}/members", | |
| "operations": [ | |
| { | |
| "summary": "Add a members to a team", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "addMember", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "userIds", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Set" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}/members", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of users assigned to a team", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getListOfUsers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "username", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}/members/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Remove a member from a team", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "removeMember", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{teamId}/roles", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of roles assigned to a team", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getListOfRoles", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/plugins/org.graylog.plugins.security/teams/{userId}/teams", | |
| "operations": [ | |
| { | |
| "summary": "Add a user to a set of teams", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "addMemberToTeams", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "teams", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Set" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.security/teams" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/plugins/org.graylog.plugins.report/widgets/dashboardId/widgetId" | |
| } | |
| { | |
| "models": { | |
| "RoleResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:roles:responses:RoleResponse", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "read_only": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "RoleMembershipResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:roles:responses:RoleMembershipResponse", | |
| "properties": { | |
| "role": { | |
| "type": "string" | |
| }, | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:UserSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "full_name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "grn_permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "preferences": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "session_timeout_ms": { | |
| "type": "integer" | |
| }, | |
| "read_only": { | |
| "type": "boolean" | |
| }, | |
| "external": { | |
| "type": "boolean" | |
| }, | |
| "startpage": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:Startpage", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "session_active": { | |
| "type": "boolean" | |
| }, | |
| "last_activity": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "client_address": { | |
| "type": "string" | |
| }, | |
| "account_status": { | |
| "type": "string", | |
| "enum": [ | |
| "enabled", | |
| "disabled", | |
| "deleted" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "RolesResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:roles:responses:RolesResponse", | |
| "properties": { | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:roles:responses:RoleResponse", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "read_only": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/roles", | |
| "operations": [ | |
| { | |
| "summary": "List all roles", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RolesResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles", | |
| "operations": [ | |
| { | |
| "summary": "Create a new role", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "The new role to create", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RoleResponse" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}", | |
| "operations": [ | |
| { | |
| "summary": "Update an existing role", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RoleResponse", | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "The new representation of the role", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RoleResponse" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve permissions for a single role", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "read", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RoleResponse", | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}", | |
| "operations": [ | |
| { | |
| "summary": "Remove the named role and dissociate any users from it", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}/members", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the role's members", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getMembers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RoleMembershipResponse", | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}/members/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Remove a user from a role", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "removeMember", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "username", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/roles/{rolename}/members/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Add a user to a role", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "addMember", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "rolename", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "username", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "Placeholder because PUT requests should have a body. Set to '{}', the content will be ignored.", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": "{}", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/roles" | |
| } | |
| { | |
| "models": { | |
| "Search": { | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Search", | |
| "properties": { | |
| "parameters": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "optional": { | |
| "type": "boolean" | |
| }, | |
| "binding": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_value": { | |
| "type": "any" | |
| }, | |
| "data_type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "queries": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Query", | |
| "properties": { | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:BackendQuery" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Filter", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "filters": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:Filter" | |
| } | |
| } | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "search_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:BackendQuery" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timerange": { | |
| "type": "any" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:Filter" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "owner": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "requires": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:views:PluginMetadataSummary", | |
| "properties": { | |
| "unique_id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "author": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "any" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SearchJob": { | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchJob", | |
| "properties": { | |
| "execution": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchJob:ExecutionInfo", | |
| "properties": { | |
| "done": { | |
| "type": "boolean" | |
| }, | |
| "cancelled": { | |
| "type": "boolean" | |
| }, | |
| "completed_exceptionally": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "results": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:QueryResult", | |
| "properties": { | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Query", | |
| "properties": { | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:BackendQuery" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Filter", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "filters": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:Filter" | |
| } | |
| } | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "search_types": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "query": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:BackendQuery" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timerange": { | |
| "type": "any" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "filter": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:Filter" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "state": { | |
| "type": "string", | |
| "enum": [ | |
| "INCOMPLETE", | |
| "FAILED", | |
| "COMPLETED" | |
| ] | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:errors:SearchError", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "search_types": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchType:Result", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "execution_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:engine:QueryExecutionStats", | |
| "properties": { | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "duration": { | |
| "type": "integer" | |
| }, | |
| "effective_timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:AbsoluteRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:org:graylog:plugins:views:search:errors:SearchError" | |
| } | |
| }, | |
| "search_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SearchMetadata": { | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:SearchMetadata", | |
| "properties": { | |
| "query_metadata": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:QueryMetadata", | |
| "properties": { | |
| "used_parameters_names": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "referenced_queries": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "declared_parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "optional": { | |
| "type": "boolean" | |
| }, | |
| "binding": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:Parameter:Binding", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_value": { | |
| "type": "any" | |
| }, | |
| "data_type": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/views/search", | |
| "operations": [ | |
| { | |
| "summary": "Get all searches which the user may see", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAllSearches", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search", | |
| "operations": [ | |
| { | |
| "summary": "Create a search query", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createSearch", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Search" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/metadata", | |
| "operations": [ | |
| { | |
| "summary": "Metadata for the posted Search object", | |
| "notes": "Intended for search objects that aren't yet persisted (e.g. for validation or interactive purposes)", | |
| "method": "POST", | |
| "nickname": "metadataForObject", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchMetadata", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Search" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/metadata/{searchId}", | |
| "operations": [ | |
| { | |
| "summary": "Metadata for the given Search object", | |
| "notes": "Used for already persisted search objects", | |
| "method": "GET", | |
| "nickname": "metadata", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchMetadata", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "searchId", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/status/{jobId}", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the status of an executed query", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "jobStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SearchJob", | |
| "parameters": [ | |
| { | |
| "name": "jobId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/sync", | |
| "operations": [ | |
| { | |
| "summary": "Execute a new synchronous search", | |
| "notes": "Executes a new search and waits for its result", | |
| "method": "POST", | |
| "nickname": "executeSyncJob", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Search" | |
| }, | |
| { | |
| "name": "timeout", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "60000", | |
| "type": "Long" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve a search query", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getSearch", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Search", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/{id}/execute", | |
| "operations": [ | |
| { | |
| "summary": "Execute the referenced search query asynchronously", | |
| "notes": "Starts a new search, irrespective whether or not another is already running", | |
| "method": "POST", | |
| "nickname": "executeQuery", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Map" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/views/search" | |
| } | |
| { | |
| "models": { | |
| "DecoratorImpl": { | |
| "id": "urn:jsonschema:org:graylog2:decorators:DecoratorImpl", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "stream": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/search/decorators", | |
| "operations": [ | |
| { | |
| "summary": "Returns all configured message decorations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/decorators", | |
| "operations": [ | |
| { | |
| "summary": "Creates a message decoration configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Decorator", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "DecoratorImpl" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/decorators/available", | |
| "operations": [ | |
| { | |
| "summary": "Returns all available message decorations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAvailable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/decorators/{decoratorId}", | |
| "operations": [ | |
| { | |
| "summary": "Update a decorator", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Decorator", | |
| "parameters": [ | |
| { | |
| "name": "decorator id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "DecoratorImpl" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/search/decorators/{decoratorId}", | |
| "operations": [ | |
| { | |
| "summary": "Create a decorator", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "decorator id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/search/decorators" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/views/functions" | |
| } | |
| { | |
| "models": { | |
| "ResultFormat": { | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:export:ResultFormat", | |
| "properties": { | |
| "limit": { | |
| "type": "integer" | |
| }, | |
| "execution_state": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "fields_in_order": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "MessagesRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:export:MessagesRequest", | |
| "properties": { | |
| "limit": { | |
| "type": "integer" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "chunk_size": { | |
| "type": "integer" | |
| }, | |
| "timerange": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:searches:timeranges:TimeRange", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "query_string": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:views:search:elasticsearch:ElasticsearchQueryString", | |
| "properties": { | |
| "query_string": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fields_in_order": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/views/search/messages", | |
| "operations": [ | |
| { | |
| "summary": "Export messages as CSV", | |
| "notes": "Use this endpoint, if you want to configure export parameters freely instead of relying on an existing Search", | |
| "method": "POST", | |
| "nickname": "retrieve", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MessagesRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/messages/{searchId}", | |
| "operations": [ | |
| { | |
| "summary": "Export a search result as CSV", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "retrieveForSearch", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "searchId", | |
| "description": "ID of an existing Search", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "Optional overrides", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ResultFormat" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/search/messages/{searchId}/{searchTypeId}", | |
| "operations": [ | |
| { | |
| "summary": "Export a message table as CSV", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "retrieveForSearchType", | |
| "produces": [ | |
| "text/csv" | |
| ], | |
| "type": "ChunkedOutput", | |
| "parameters": [ | |
| { | |
| "name": "searchId", | |
| "description": "ID of an existing Search", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "searchTypeId", | |
| "description": "ID of a Message Table contained in the Search", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "Optional overrides", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ResultFormat" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/views/search/messages" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/search/saved", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all searches", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "views", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/search/saved" | |
| } | |
| { | |
| "models": { | |
| "SidecarSummary": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:SidecarSummary", | |
| "properties": { | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "node_name": { | |
| "type": "string" | |
| }, | |
| "node_details": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeDetails", | |
| "properties": { | |
| "operating_system": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "metrics": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeMetrics", | |
| "properties": { | |
| "disks_75": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cpu_idle": { | |
| "type": "number" | |
| }, | |
| "load_1": { | |
| "type": "number" | |
| } | |
| } | |
| }, | |
| "log_file_list": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeLogFile", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "mod_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "is_dir": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:CollectorStatusList", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:CollectorStatus", | |
| "properties": { | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "verbose_message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "assignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:ConfigurationAssignment", | |
| "properties": { | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "configuration_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "last_seen": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "sidecar_version": { | |
| "type": "string" | |
| }, | |
| "active": { | |
| "type": "boolean" | |
| }, | |
| "collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "NodeConfigurationRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:NodeConfigurationRequest", | |
| "properties": { | |
| "nodes": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeConfiguration", | |
| "properties": { | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "assignments": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:ConfigurationAssignment", | |
| "properties": { | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "configuration_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "RegistrationRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:RegistrationRequest", | |
| "properties": { | |
| "node_name": { | |
| "type": "string" | |
| }, | |
| "node_details": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeDetails", | |
| "properties": { | |
| "operating_system": { | |
| "type": "string" | |
| }, | |
| "ip": { | |
| "type": "string" | |
| }, | |
| "metrics": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeMetrics", | |
| "properties": { | |
| "disks_75": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "cpu_idle": { | |
| "type": "number" | |
| }, | |
| "load_1": { | |
| "type": "number" | |
| } | |
| } | |
| }, | |
| "log_file_list": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:NodeLogFile", | |
| "properties": { | |
| "path": { | |
| "type": "string" | |
| }, | |
| "mod_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| }, | |
| "is_dir": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:CollectorStatusList", | |
| "properties": { | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:CollectorStatus", | |
| "properties": { | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "message": { | |
| "type": "string" | |
| }, | |
| "verbose_message": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecars", | |
| "operations": [ | |
| { | |
| "summary": "Lists existing Sidecar registrations using pagination", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "sidecars", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SidecarListResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "node_name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "only_active", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecars/all", | |
| "operations": [ | |
| { | |
| "summary": "Lists all existing Sidecar registrations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SidecarListResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecars/configurations", | |
| "operations": [ | |
| { | |
| "summary": "Assign configurations to sidecars", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "assignConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "NodeConfigurationRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecars/{sidecarId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns at most one Sidecar summary for the specified id", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SidecarSummary", | |
| "parameters": [ | |
| { | |
| "name": "sidecarId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No Sidecar with the specified id exists" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecars/{sidecarId}", | |
| "operations": [ | |
| { | |
| "summary": "Create/update a Sidecar registration", | |
| "notes": "This is a stateless method which upserts a Sidecar registration", | |
| "method": "PUT", | |
| "nickname": "register", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "sidecarId", | |
| "description": "The id this Sidecar is registering as.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "RegistrationRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied request is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/sidecars" | |
| } | |
| { | |
| "models": { | |
| "BulkActionsRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:BulkActionsRequest", | |
| "properties": { | |
| "action": { | |
| "type": "string" | |
| }, | |
| "collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:BulkActionRequest", | |
| "properties": { | |
| "sidecar_id": { | |
| "type": "string" | |
| }, | |
| "collector_ids": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "AdministrationRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:AdministrationRequest", | |
| "properties": { | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "query": { | |
| "type": "string" | |
| }, | |
| "filters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecar/administration", | |
| "operations": [ | |
| { | |
| "summary": "Lists existing Sidecar registrations including compatible sidecars using pagination", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "administration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SidecarListResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AdministrationRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/administration/action", | |
| "operations": [ | |
| { | |
| "summary": "Set collector actions in bulk", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "setAction", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "BulkActionsRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied action is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/sidecar/administration" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecar/action/{sidecarId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns queued actions for the specified Sidecar id", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAction", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "parameters": [ | |
| { | |
| "name": "sidecarId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No actions found for specified id" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/action/{sidecarId}", | |
| "operations": [ | |
| { | |
| "summary": "Set a collector action", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "setAction", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "sidecarId", | |
| "description": "The id this Sidecar is registering as.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "List" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "The supplied action is not valid." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/sidecar/action" | |
| } | |
| { | |
| "models": { | |
| "Collector": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:Collector", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "service_type": { | |
| "type": "string" | |
| }, | |
| "node_operating_system": { | |
| "type": "string" | |
| }, | |
| "executable_path": { | |
| "type": "string" | |
| }, | |
| "execute_parameters": { | |
| "type": "string" | |
| }, | |
| "validation_parameters": { | |
| "type": "string" | |
| }, | |
| "default_template": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ValidationResult": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:rest:ValidationResult", | |
| "properties": { | |
| "errors": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "error_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "failed": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecar/collectors", | |
| "operations": [ | |
| { | |
| "summary": "Create a new collector", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Collector" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors", | |
| "operations": [ | |
| { | |
| "summary": "List all collectors", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listCollectors", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/summary", | |
| "operations": [ | |
| { | |
| "summary": "List a summary of all collectors", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listSummary", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorSummaryResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validates collector parameters", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "collector", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Collector" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a collector", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Show collector details", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collector", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a collector", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Collector" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/collectors/{id}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a collector", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "copyCollector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "name", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/sidecar/collectors" | |
| } | |
| { | |
| "models": { | |
| "ValidationResult": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:rest:ValidationResult", | |
| "properties": { | |
| "errors": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "error_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "failed": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecar/configuration_variables", | |
| "operations": [ | |
| { | |
| "summary": "List all configuration variables", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listConfigurationVariables", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configuration_variables", | |
| "operations": [ | |
| { | |
| "summary": "Create new configuration variable", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createConfigurationVariable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ConfigurationVariable" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configuration_variables/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validate a configuration variable", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateConfigurationVariable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ConfigurationVariable" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configuration_variables/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a configuration variable", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfigurationVariable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ConfigurationVariable" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configuration_variables/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a configuration variable", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteConfigurationVariable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configuration_variables/{id}/configurations", | |
| "operations": [ | |
| { | |
| "summary": "Show configurations using this variable", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfigurationVariablesConfigurations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "List", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/sidecar/configuration_variables" | |
| } | |
| { | |
| "models": { | |
| "Configuration": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:models:Configuration", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "collector_id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "template": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ConfigurationPreviewRequest": { | |
| "id": "urn:jsonschema:org:graylog:plugins:sidecar:rest:requests:ConfigurationPreviewRequest", | |
| "properties": { | |
| "template": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ValidationResult": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:rest:ValidationResult", | |
| "properties": { | |
| "errors": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "error_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "failed": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/sidecar/configurations", | |
| "operations": [ | |
| { | |
| "summary": "Create new configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Configuration" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations", | |
| "operations": [ | |
| { | |
| "summary": "List all configurations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listConfigurations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ConfigurationListResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/render/preview", | |
| "operations": [ | |
| { | |
| "summary": "Render preview of a configuration template", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "renderConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ConfigurationPreviewRenderResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ConfigurationPreviewRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/render/{sidecarId}/{configurationId}", | |
| "operations": [ | |
| { | |
| "summary": "Render configuration template", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "renderConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "sidecarId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "configurationId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/uploads", | |
| "operations": [ | |
| { | |
| "summary": "List all uploaded configurations", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listImports", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CollectorUploadListResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validates configuration parameters", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "configuration", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Configuration" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Show configuration details", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfigurations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Configuration", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Update a configuration", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Configuration" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a configuration", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/{id}/sidecars", | |
| "operations": [ | |
| { | |
| "summary": "Show sidecars using the given configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfigurationSidecars", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ConfigurationSidecarsResponse", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/sidecar/configurations/{id}/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Copy a configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "copyConfiguration", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/sidecar/configurations" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/inputs/inputId/staticfields" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/streams/streamid/alarmcallbacks" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/streams/streamId/alerts/conditions" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/streams/streamId/alerts" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/streams/streamid/outputs" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/streams/streamid/rules" | |
| } | |
| { | |
| "models": { | |
| "CloneStreamRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:requests:CloneStreamRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "UpdateStreamRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:requests:UpdateStreamRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "matching_type": { | |
| "type": "string" | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CreateStreamRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:requests:CreateStreamRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:rules:requests:CreateStreamRuleRequest", | |
| "properties": { | |
| "type": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "field": { | |
| "type": "string" | |
| }, | |
| "inverted": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "matching_type": { | |
| "type": "string", | |
| "enum": [ | |
| "AND", | |
| "OR" | |
| ] | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "StreamListResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:responses:StreamListResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:responses:StreamResponse", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "outputs": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:outputs:responses:OutputSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "matching_type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string" | |
| }, | |
| "disabled": { | |
| "type": "boolean" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:streams:StreamRule", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "EXACT", | |
| "REGEX", | |
| "GREATER", | |
| "SMALLER", | |
| "PRESENCE", | |
| "CONTAINS", | |
| "ALWAYS_MATCH", | |
| "MATCH_INPUT" | |
| ] | |
| }, | |
| "field": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "inverted": { | |
| "type": "boolean" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "validations": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "alert_conditions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertConditionSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "in_grace": { | |
| "type": "boolean" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "alert_receivers": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:alarmcallbacks:requests:AlertReceivers", | |
| "properties": { | |
| "emails": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "is_default": { | |
| "type": "boolean" | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "StreamResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:responses:StreamResponse", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "outputs": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:outputs:responses:OutputSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "matching_type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string" | |
| }, | |
| "disabled": { | |
| "type": "boolean" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:streams:StreamRule", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "EXACT", | |
| "REGEX", | |
| "GREATER", | |
| "SMALLER", | |
| "PRESENCE", | |
| "CONTAINS", | |
| "ALWAYS_MATCH", | |
| "MATCH_INPUT" | |
| ] | |
| }, | |
| "field": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "inverted": { | |
| "type": "boolean" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "validations": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "alert_conditions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertConditionSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "in_grace": { | |
| "type": "boolean" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "alert_receivers": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:alarmcallbacks:requests:AlertReceivers", | |
| "properties": { | |
| "emails": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "is_default": { | |
| "type": "boolean" | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "TestMatchResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:responses:TestMatchResponse", | |
| "properties": { | |
| "matches": { | |
| "type": "boolean" | |
| }, | |
| "rules": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "StreamPageListResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:streams:responses:StreamPageListResponse", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "pagination": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:database:PaginatedList:PaginationInfo", | |
| "properties": { | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "sort": { | |
| "type": "string" | |
| }, | |
| "order": { | |
| "type": "string" | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:streams:StreamDTO", | |
| "properties": { | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "outputs": { | |
| "type": "array", | |
| "items": { | |
| "type": "any" | |
| } | |
| }, | |
| "matching_type": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string" | |
| }, | |
| "disabled": { | |
| "type": "boolean" | |
| }, | |
| "rules": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:streams:StreamRule", | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "EXACT", | |
| "REGEX", | |
| "GREATER", | |
| "SMALLER", | |
| "PRESENCE", | |
| "CONTAINS", | |
| "ALWAYS_MATCH", | |
| "MATCH_INPUT" | |
| ] | |
| }, | |
| "field": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "stream_id": { | |
| "type": "string" | |
| }, | |
| "inverted": { | |
| "type": "boolean" | |
| }, | |
| "fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "validations": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "alert_conditions": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:alerts:AlertConditionSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "in_grace": { | |
| "type": "boolean" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "alert_receivers": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:alarmcallbacks:requests:AlertReceivers", | |
| "properties": { | |
| "emails": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "remove_matches_from_default_stream": { | |
| "type": "boolean" | |
| }, | |
| "index_set_id": { | |
| "type": "string" | |
| }, | |
| "is_default": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/streams", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all streams", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamListResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams", | |
| "operations": [ | |
| { | |
| "summary": "Create a stream", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CreateStreamRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/enabled", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all enabled streams", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getEnabled", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamListResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/paginated", | |
| "operations": [ | |
| { | |
| "summary": "Get a paginated list of streams", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPage", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamPageListResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single stream", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamResponse", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}", | |
| "operations": [ | |
| { | |
| "summary": "Update a stream", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "StreamResponse", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "UpdateStreamRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a stream", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid ObjectId." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}/clone", | |
| "operations": [ | |
| { | |
| "summary": "Clone a stream", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "cloneStream", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CloneStreamRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid or missing Stream id." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}/pause", | |
| "operations": [ | |
| { | |
| "summary": "Pause a stream", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "pause", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid or missing Stream id." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}/resume", | |
| "operations": [ | |
| { | |
| "summary": "Resume a stream", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "resume", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid or missing Stream id." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/streams/{streamId}/testMatch", | |
| "operations": [ | |
| { | |
| "summary": "Test matching of a stream against a supplied message", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "testMatch", | |
| "type": "TestMatchResponse", | |
| "parameters": [ | |
| { | |
| "name": "streamId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Map" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Stream not found." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Invalid or missing Stream id." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/streams" | |
| } | |
| { | |
| "models": { | |
| "SystemOverviewResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemOverviewResponse", | |
| "properties": { | |
| "facility": { | |
| "type": "string" | |
| }, | |
| "codename": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "cluster_id": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string" | |
| }, | |
| "is_processing": { | |
| "type": "boolean" | |
| }, | |
| "hostname": { | |
| "type": "string" | |
| }, | |
| "lifecycle": { | |
| "type": "string" | |
| }, | |
| "lb_status": { | |
| "type": "string" | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "operating_system": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LocalesResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:LocalesResponse", | |
| "properties": { | |
| "locales": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:LocalesResponse:LocaleDescription", | |
| "properties": { | |
| "display_name": { | |
| "type": "string" | |
| }, | |
| "language_tag": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "SystemProcessBufferDumpResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemProcessBufferDumpResponse", | |
| "properties": { | |
| "processbuffer_dump": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "SystemThreadDumpResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemThreadDumpResponse", | |
| "properties": { | |
| "threaddump": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "SystemJVMResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:SystemJVMResponse", | |
| "properties": { | |
| "free_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "max_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "used_memory": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "pid": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system", | |
| "operations": [ | |
| { | |
| "summary": "Get system overview", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "system", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemOverviewResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/jvm", | |
| "operations": [ | |
| { | |
| "summary": "Get JVM information", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "jvm", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJVMResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/locales", | |
| "operations": [ | |
| { | |
| "summary": "Get supported locales", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "locales", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LocalesResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/processbufferdump", | |
| "operations": [ | |
| { | |
| "summary": "Get a process buffer dump", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "processBufferDump", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemProcessBufferDumpResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/threaddump", | |
| "operations": [ | |
| { | |
| "summary": "Get a thread dump", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "threaddump", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemThreadDumpResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/threaddump", | |
| "operations": [ | |
| { | |
| "summary": "Get a thread dump as plain text", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "threadDumpAsText", | |
| "produces": [ | |
| "text/plain" | |
| ], | |
| "type": "StreamingOutput", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/authentication/http-header-auth-config", | |
| "operations": [ | |
| { | |
| "summary": "Get HTTP header authentication config", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "HTTPHeaderAuthConfig", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/http-header-auth-config", | |
| "operations": [ | |
| { | |
| "summary": "Update HTTP header authentication config", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "HTTPHeaderAuthConfig", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/authentication/http-header-auth-config" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/authentication/services/active-backend", | |
| "operations": [ | |
| { | |
| "summary": "Get active authentication service backend", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/authentication/services" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "AuthServiceBackendDTO": { | |
| "id": "urn:jsonschema:org:graylog:security:authservice:AuthServiceBackendDTO", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog:security:authservice:AuthServiceBackendConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "default_roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/authentication/services/backends", | |
| "operations": [ | |
| { | |
| "summary": "Creates a new authentication service backend", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AuthServiceBackendDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/backends", | |
| "operations": [ | |
| { | |
| "summary": "Returns available authentication service backends", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "pagination parameters", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PaginationParameters" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/backends/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Returns the authentication service backend for the given ID", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/backends/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Updates an existing authentication service backend", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AuthServiceBackendDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/backends/{backendId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete authentication service backend", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/backends/{backendId}/users", | |
| "operations": [ | |
| { | |
| "summary": "Get paginated users for an authentication service backend", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getUsers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "full_name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "backendId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/authentication/services/backends" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/authentication/services/configuration", | |
| "operations": [ | |
| { | |
| "summary": "Get global authentication services configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/configuration", | |
| "operations": [ | |
| { | |
| "summary": "Update global authentication services configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Data" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/authentication/services/configuration" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/authentication/services/test/backend/connection", | |
| "operations": [ | |
| { | |
| "summary": "Test authentication service backend connection", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "backendConnection", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AuthServiceBackendTestRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/authentication/services/test/backend/login", | |
| "operations": [ | |
| { | |
| "summary": "Test authentication service backend login", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "backendLogin", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "AuthServiceBackendTestRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/authentication/services/test" | |
| } | |
| { | |
| "models": { | |
| "CatalogResolveRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:CatalogResolveRequest", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:EntityDescriptor", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CatalogResolveResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:CatalogResolveResponse", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:Entity", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "v": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CatalogIndexResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:CatalogIndexResponse", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:EntityExcerpt", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/catalog", | |
| "operations": [ | |
| { | |
| "summary": "List available entities in this Graylog cluster", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showEntityIndex", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CatalogIndexResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/catalog", | |
| "operations": [ | |
| { | |
| "summary": "Resolve dependencies of entities and return their configuration", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "resolveEntities", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CatalogResolveResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CatalogResolveRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/catalog" | |
| } | |
| { | |
| "models": { | |
| "NodeSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:cluster:responses:NodeSummary", | |
| "properties": { | |
| "cluster_id": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "is_master": { | |
| "type": "boolean" | |
| }, | |
| "transport_address": { | |
| "type": "string" | |
| }, | |
| "last_seen": { | |
| "type": "string" | |
| }, | |
| "short_node_id": { | |
| "type": "string" | |
| }, | |
| "hostname": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "NodeSummaryList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:cluster:responses:NodeSummaryList", | |
| "properties": { | |
| "nodes": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:cluster:responses:NodeSummary", | |
| "properties": { | |
| "cluster_id": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "is_master": { | |
| "type": "boolean" | |
| }, | |
| "transport_address": { | |
| "type": "string" | |
| }, | |
| "last_seen": { | |
| "type": "string" | |
| }, | |
| "short_node_id": { | |
| "type": "string" | |
| }, | |
| "hostname": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/cluster/node", | |
| "operations": [ | |
| { | |
| "summary": "Information about this node.", | |
| "notes": "This is returning information of this node in context to its state in the cluster. Use the system API of the node itself to get system information.", | |
| "method": "GET", | |
| "nickname": "node", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "NodeSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster/nodes", | |
| "operations": [ | |
| { | |
| "summary": "List all active nodes in this cluster.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "nodes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "NodeSummaryList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster/nodes/{nodeId}", | |
| "operations": [ | |
| { | |
| "summary": "Information about a node.", | |
| "notes": "This is returning information of a node in context to its state in the cluster. Use the system API of the node itself to get system information.", | |
| "method": "GET", | |
| "nickname": "node", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "NodeSummary", | |
| "parameters": [ | |
| { | |
| "name": "nodeId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Node not found." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/cluster" | |
| } | |
| { | |
| "models": { | |
| "ClusterConfigList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:config:ClusterConfigList", | |
| "properties": { | |
| "classes": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/cluster_config", | |
| "operations": [ | |
| { | |
| "summary": "List all configuration classes", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClusterConfigList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster_config/{configClass}", | |
| "operations": [ | |
| { | |
| "summary": "Update configuration in database", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "configClass", | |
| "description": "The name of the cluster configuration class", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "body", | |
| "description": "The payload of the cluster configuration", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "InputStream" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster_config/{configClass}", | |
| "operations": [ | |
| { | |
| "summary": "Get configuration settings from database", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "read", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "configClass", | |
| "description": "The name of the cluster configuration class", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster_config/{configClass}", | |
| "operations": [ | |
| { | |
| "summary": "Delete configuration settings from database", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "configClass", | |
| "description": "The name of the cluster configuration class", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster_config/{configClass}", | |
| "operations": [ | |
| { | |
| "summary": "Get JSON schema of configuration class", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "schema", | |
| "produces": [ | |
| "application/schema+json" | |
| ], | |
| "type": "JsonSchema", | |
| "parameters": [ | |
| { | |
| "name": "configClass", | |
| "description": "The name of the cluster configuration class", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/cluster_config" | |
| } | |
| { | |
| "models": { | |
| "MongoStats": { | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:MongoStats", | |
| "properties": { | |
| "host_info": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo", | |
| "properties": { | |
| "extra": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:Extra", | |
| "properties": { | |
| "num_pages": { | |
| "type": "integer" | |
| }, | |
| "cpu_frequency_mhz": { | |
| "type": "string" | |
| }, | |
| "libc_version": { | |
| "type": "string" | |
| }, | |
| "max_open_files": { | |
| "type": "integer" | |
| }, | |
| "cpu_features": { | |
| "type": "string" | |
| }, | |
| "scheduler": { | |
| "type": "string" | |
| }, | |
| "kernel_version": { | |
| "type": "string" | |
| }, | |
| "version_string": { | |
| "type": "string" | |
| }, | |
| "page_size": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "os": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:Os", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "system": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:System", | |
| "properties": { | |
| "cpu_addr_size": { | |
| "type": "integer" | |
| }, | |
| "numa_enabled": { | |
| "type": "boolean" | |
| }, | |
| "cpu_arch": { | |
| "type": "string" | |
| }, | |
| "mem_size_mb": { | |
| "type": "integer" | |
| }, | |
| "num_cores": { | |
| "type": "integer" | |
| }, | |
| "hostname": { | |
| "type": "string" | |
| }, | |
| "current_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "database_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats", | |
| "properties": { | |
| "file_size": { | |
| "type": "integer" | |
| }, | |
| "num_extents": { | |
| "type": "integer" | |
| }, | |
| "ns_size_mb": { | |
| "type": "integer" | |
| }, | |
| "extent_free_list": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats:ExtentFreeList", | |
| "properties": { | |
| "total_size": { | |
| "type": "integer" | |
| }, | |
| "num": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "data_file_version": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats:DataFileVersion", | |
| "properties": { | |
| "major": { | |
| "type": "integer" | |
| }, | |
| "minor": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "avg_obj_size": { | |
| "type": "number" | |
| }, | |
| "storage_size": { | |
| "type": "integer" | |
| }, | |
| "data_size": { | |
| "type": "integer" | |
| }, | |
| "objects": { | |
| "type": "integer" | |
| }, | |
| "db": { | |
| "type": "string" | |
| }, | |
| "indexes": { | |
| "type": "integer" | |
| }, | |
| "index_size": { | |
| "type": "integer" | |
| }, | |
| "collections": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "server_status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus", | |
| "properties": { | |
| "uptime_millis": { | |
| "type": "integer" | |
| }, | |
| "uptime_estimate": { | |
| "type": "integer" | |
| }, | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Memory", | |
| "properties": { | |
| "mapped_with_journal": { | |
| "type": "integer" | |
| }, | |
| "resident": { | |
| "type": "integer" | |
| }, | |
| "supported": { | |
| "type": "boolean" | |
| }, | |
| "mapped": { | |
| "type": "integer" | |
| }, | |
| "virtual": { | |
| "type": "integer" | |
| }, | |
| "bits": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "network": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Network", | |
| "properties": { | |
| "bytes_in": { | |
| "type": "integer" | |
| }, | |
| "num_requests": { | |
| "type": "integer" | |
| }, | |
| "bytes_out": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "process": { | |
| "type": "string" | |
| }, | |
| "local_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "pid": { | |
| "type": "integer" | |
| }, | |
| "storage_engine": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:StorageEngine", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "uptime": { | |
| "type": "integer" | |
| }, | |
| "connections": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Connections", | |
| "properties": { | |
| "total_created": { | |
| "type": "integer" | |
| }, | |
| "current": { | |
| "type": "integer" | |
| }, | |
| "available": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "host": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "servers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "build_info": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:BuildInfo", | |
| "properties": { | |
| "loader_flags": { | |
| "type": "string" | |
| }, | |
| "compiler_flags": { | |
| "type": "string" | |
| }, | |
| "sys_info": { | |
| "type": "string" | |
| }, | |
| "javascript_engine": { | |
| "type": "string" | |
| }, | |
| "git_version": { | |
| "type": "string" | |
| }, | |
| "max_bson_object_size": { | |
| "type": "integer" | |
| }, | |
| "version_array": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer" | |
| } | |
| }, | |
| "allocator": { | |
| "type": "string" | |
| }, | |
| "debug": { | |
| "type": "boolean" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "bits": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ClusterStats": { | |
| "id": "urn:jsonschema:org:graylog2:system:stats:ClusterStats", | |
| "properties": { | |
| "user_count": { | |
| "type": "integer" | |
| }, | |
| "dashboard_count": { | |
| "type": "integer" | |
| }, | |
| "extractor_count": { | |
| "type": "integer" | |
| }, | |
| "alarm_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:AlarmStats", | |
| "properties": { | |
| "alert_count": { | |
| "type": "integer" | |
| }, | |
| "alarmcallback_count_by_type": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "input_count": { | |
| "type": "integer" | |
| }, | |
| "global_input_count": { | |
| "type": "integer" | |
| }, | |
| "stream_count": { | |
| "type": "integer" | |
| }, | |
| "output_count_by_type": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "extractor_count_by_type": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "output_count": { | |
| "type": "integer" | |
| }, | |
| "input_count_by_type": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "stream_rule_count_by_stream": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "stream_rule_count": { | |
| "type": "integer" | |
| }, | |
| "mongo": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:MongoStats", | |
| "properties": { | |
| "host_info": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo", | |
| "properties": { | |
| "extra": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:Extra", | |
| "properties": { | |
| "num_pages": { | |
| "type": "integer" | |
| }, | |
| "cpu_frequency_mhz": { | |
| "type": "string" | |
| }, | |
| "libc_version": { | |
| "type": "string" | |
| }, | |
| "max_open_files": { | |
| "type": "integer" | |
| }, | |
| "cpu_features": { | |
| "type": "string" | |
| }, | |
| "scheduler": { | |
| "type": "string" | |
| }, | |
| "kernel_version": { | |
| "type": "string" | |
| }, | |
| "version_string": { | |
| "type": "string" | |
| }, | |
| "page_size": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "os": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:Os", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "system": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:HostInfo:System", | |
| "properties": { | |
| "cpu_addr_size": { | |
| "type": "integer" | |
| }, | |
| "numa_enabled": { | |
| "type": "boolean" | |
| }, | |
| "cpu_arch": { | |
| "type": "string" | |
| }, | |
| "mem_size_mb": { | |
| "type": "integer" | |
| }, | |
| "num_cores": { | |
| "type": "integer" | |
| }, | |
| "hostname": { | |
| "type": "string" | |
| }, | |
| "current_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "database_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats", | |
| "properties": { | |
| "file_size": { | |
| "type": "integer" | |
| }, | |
| "num_extents": { | |
| "type": "integer" | |
| }, | |
| "ns_size_mb": { | |
| "type": "integer" | |
| }, | |
| "extent_free_list": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats:ExtentFreeList", | |
| "properties": { | |
| "total_size": { | |
| "type": "integer" | |
| }, | |
| "num": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "data_file_version": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:DatabaseStats:DataFileVersion", | |
| "properties": { | |
| "major": { | |
| "type": "integer" | |
| }, | |
| "minor": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "avg_obj_size": { | |
| "type": "number" | |
| }, | |
| "storage_size": { | |
| "type": "integer" | |
| }, | |
| "data_size": { | |
| "type": "integer" | |
| }, | |
| "objects": { | |
| "type": "integer" | |
| }, | |
| "db": { | |
| "type": "string" | |
| }, | |
| "indexes": { | |
| "type": "integer" | |
| }, | |
| "index_size": { | |
| "type": "integer" | |
| }, | |
| "collections": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "server_status": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus", | |
| "properties": { | |
| "uptime_millis": { | |
| "type": "integer" | |
| }, | |
| "uptime_estimate": { | |
| "type": "integer" | |
| }, | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Memory", | |
| "properties": { | |
| "mapped_with_journal": { | |
| "type": "integer" | |
| }, | |
| "resident": { | |
| "type": "integer" | |
| }, | |
| "supported": { | |
| "type": "boolean" | |
| }, | |
| "mapped": { | |
| "type": "integer" | |
| }, | |
| "virtual": { | |
| "type": "integer" | |
| }, | |
| "bits": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "network": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Network", | |
| "properties": { | |
| "bytes_in": { | |
| "type": "integer" | |
| }, | |
| "num_requests": { | |
| "type": "integer" | |
| }, | |
| "bytes_out": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "process": { | |
| "type": "string" | |
| }, | |
| "local_time": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "pid": { | |
| "type": "integer" | |
| }, | |
| "storage_engine": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:StorageEngine", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "uptime": { | |
| "type": "integer" | |
| }, | |
| "connections": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:ServerStatus:Connections", | |
| "properties": { | |
| "total_created": { | |
| "type": "integer" | |
| }, | |
| "current": { | |
| "type": "integer" | |
| }, | |
| "available": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "host": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "servers": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "build_info": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:mongo:BuildInfo", | |
| "properties": { | |
| "loader_flags": { | |
| "type": "string" | |
| }, | |
| "compiler_flags": { | |
| "type": "string" | |
| }, | |
| "sys_info": { | |
| "type": "string" | |
| }, | |
| "javascript_engine": { | |
| "type": "string" | |
| }, | |
| "git_version": { | |
| "type": "string" | |
| }, | |
| "max_bson_object_size": { | |
| "type": "integer" | |
| }, | |
| "version_array": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer" | |
| } | |
| }, | |
| "allocator": { | |
| "type": "string" | |
| }, | |
| "debug": { | |
| "type": "boolean" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "bits": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "elasticsearch": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:ElasticsearchStats", | |
| "properties": { | |
| "indices_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:IndicesStats", | |
| "properties": { | |
| "field_data_size": { | |
| "type": "integer" | |
| }, | |
| "id_cache_size": { | |
| "type": "integer" | |
| }, | |
| "store_size": { | |
| "type": "integer" | |
| }, | |
| "index_count": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cluster_name": { | |
| "type": "string" | |
| }, | |
| "cluster_version": { | |
| "type": "string" | |
| }, | |
| "nodes_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:NodesStats", | |
| "properties": { | |
| "master_data": { | |
| "type": "integer" | |
| }, | |
| "data_only": { | |
| "type": "integer" | |
| }, | |
| "client": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "master_only": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cluster_health": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:ClusterHealth", | |
| "properties": { | |
| "active_primary_shards": { | |
| "type": "integer" | |
| }, | |
| "number_of_nodes": { | |
| "type": "integer" | |
| }, | |
| "relocating_shards": { | |
| "type": "integer" | |
| }, | |
| "initializing_shards": { | |
| "type": "integer" | |
| }, | |
| "active_shards": { | |
| "type": "integer" | |
| }, | |
| "unassigned_shards": { | |
| "type": "integer" | |
| }, | |
| "pending_tasks": { | |
| "type": "integer" | |
| }, | |
| "pending_tasks_time_in_queue": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer" | |
| } | |
| }, | |
| "timed_out": { | |
| "type": "boolean" | |
| }, | |
| "number_of_data_nodes": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Red", | |
| "Yellow", | |
| "Green" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ElasticsearchStats": { | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:ElasticsearchStats", | |
| "properties": { | |
| "indices_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:IndicesStats", | |
| "properties": { | |
| "field_data_size": { | |
| "type": "integer" | |
| }, | |
| "id_cache_size": { | |
| "type": "integer" | |
| }, | |
| "store_size": { | |
| "type": "integer" | |
| }, | |
| "index_count": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cluster_name": { | |
| "type": "string" | |
| }, | |
| "cluster_version": { | |
| "type": "string" | |
| }, | |
| "nodes_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:NodesStats", | |
| "properties": { | |
| "master_data": { | |
| "type": "integer" | |
| }, | |
| "data_only": { | |
| "type": "integer" | |
| }, | |
| "client": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "master_only": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cluster_health": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:stats:elasticsearch:ClusterHealth", | |
| "properties": { | |
| "active_primary_shards": { | |
| "type": "integer" | |
| }, | |
| "number_of_nodes": { | |
| "type": "integer" | |
| }, | |
| "relocating_shards": { | |
| "type": "integer" | |
| }, | |
| "initializing_shards": { | |
| "type": "integer" | |
| }, | |
| "active_shards": { | |
| "type": "integer" | |
| }, | |
| "unassigned_shards": { | |
| "type": "integer" | |
| }, | |
| "pending_tasks": { | |
| "type": "integer" | |
| }, | |
| "pending_tasks_time_in_queue": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer" | |
| } | |
| }, | |
| "timed_out": { | |
| "type": "boolean" | |
| }, | |
| "number_of_data_nodes": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "status": { | |
| "type": "string", | |
| "enum": [ | |
| "Red", | |
| "Yellow", | |
| "Green" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/cluster/stats", | |
| "operations": [ | |
| { | |
| "summary": "Cluster status information.", | |
| "notes": "This resource returns information about the Graylog cluster.", | |
| "method": "GET", | |
| "nickname": "systemStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ClusterStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster/stats/elasticsearch", | |
| "operations": [ | |
| { | |
| "summary": "Elasticsearch information.", | |
| "notes": "This resource returns information about the Elasticsearch Cluster.", | |
| "method": "GET", | |
| "nickname": "elasticsearchStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ElasticsearchStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/cluster/stats/mongo", | |
| "operations": [ | |
| { | |
| "summary": "MongoDB information.", | |
| "notes": "This resource returns information about MongoDB.", | |
| "method": "GET", | |
| "nickname": "mongoStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MongoStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/cluster/stats" | |
| } | |
| { | |
| "models": { | |
| "TrafficHistogram": { | |
| "id": "urn:jsonschema:org:graylog2:system:traffic:TrafficCounterService:TrafficHistogram", | |
| "properties": { | |
| "from": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "to": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "input": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "output": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| }, | |
| "decoded": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/cluster/traffic", | |
| "operations": [ | |
| { | |
| "summary": "Get the cluster traffic stats", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "TrafficHistogram", | |
| "parameters": [ | |
| { | |
| "name": "days", | |
| "description": "For how many days the traffic stats should be returned", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "30", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "daily", | |
| "description": "Whether the traffic should be aggregate to daily values", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/cluster/traffic" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/codecs/types/all", | |
| "operations": [ | |
| { | |
| "summary": "Get all codec types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAll", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/codecs/types" | |
| } | |
| { | |
| "models": { | |
| "ExposedConfiguration": { | |
| "id": "urn:jsonschema:org:graylog2:configuration:ExposedConfiguration", | |
| "properties": { | |
| "inputbuffer_processors": { | |
| "type": "integer" | |
| }, | |
| "processbuffer_processors": { | |
| "type": "integer" | |
| }, | |
| "outputbuffer_processors": { | |
| "type": "integer" | |
| }, | |
| "processor_wait_strategy": { | |
| "type": "string" | |
| }, | |
| "inputbuffer_wait_strategy": { | |
| "type": "string" | |
| }, | |
| "inputbuffer_ring_size": { | |
| "type": "integer" | |
| }, | |
| "ring_size": { | |
| "type": "integer" | |
| }, | |
| "bin_dir": { | |
| "type": "string" | |
| }, | |
| "data_dir": { | |
| "type": "string" | |
| }, | |
| "plugin_dir": { | |
| "type": "string" | |
| }, | |
| "node_id_file": { | |
| "type": "string" | |
| }, | |
| "allow_highlighting": { | |
| "type": "boolean" | |
| }, | |
| "allow_leading_wildcard_searches": { | |
| "type": "boolean" | |
| }, | |
| "stream_processing_timeout": { | |
| "type": "integer" | |
| }, | |
| "stream_processing_max_faults": { | |
| "type": "integer" | |
| }, | |
| "output_module_timeout": { | |
| "type": "integer" | |
| }, | |
| "stale_master_timeout": { | |
| "type": "integer" | |
| }, | |
| "gc_warning_threshold": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/configuration", | |
| "operations": [ | |
| { | |
| "summary": "Get relevant configuration settings and their values", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getRelevant", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ExposedConfiguration", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/configuration" | |
| } | |
| { | |
| "models": { | |
| "ContentPackList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackList", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "content_packs": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPack", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "rev": { | |
| "type": "integer" | |
| }, | |
| "v": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "content_packs_metadata": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackMetadata", | |
| "properties": { | |
| "installation_count": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentPackInstallation": { | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPackInstallation", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:NativeEntityDescriptor", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "found_on_system": { | |
| "type": "boolean" | |
| }, | |
| "content_pack_entity_id": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:references:ValueReference", | |
| "properties": { | |
| "@value": { | |
| "type": "any" | |
| }, | |
| "@type": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| }, | |
| "_id": { | |
| "type": "any" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "content_pack_id": { | |
| "type": "string" | |
| }, | |
| "content_pack_revision": { | |
| "type": "integer" | |
| }, | |
| "created_by": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ContentPackUninstallDetails": { | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPackUninstallDetails", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:NativeEntityDescriptor", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "found_on_system": { | |
| "type": "boolean" | |
| }, | |
| "content_pack_entity_id": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentPackInstallationsResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackInstallationsResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "installations": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPackInstallation", | |
| "properties": { | |
| "entities": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:NativeEntityDescriptor", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "found_on_system": { | |
| "type": "boolean" | |
| }, | |
| "content_pack_entity_id": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ModelType", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:references:ValueReference", | |
| "properties": { | |
| "@value": { | |
| "type": "any" | |
| }, | |
| "@type": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| }, | |
| "_id": { | |
| "type": "any" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "content_pack_id": { | |
| "type": "string" | |
| }, | |
| "content_pack_revision": { | |
| "type": "integer" | |
| }, | |
| "created_by": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentPackRevisions": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackRevisions", | |
| "properties": { | |
| "content_pack_revisions": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPack", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "rev": { | |
| "type": "integer" | |
| }, | |
| "v": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "constraints_result": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:constraints:ConstraintCheckResult", | |
| "properties": { | |
| "constraint": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:constraints:Constraint", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fulfilled": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentPackResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackResponse", | |
| "properties": { | |
| "content_pack": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:ContentPack", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "rev": { | |
| "type": "integer" | |
| }, | |
| "v": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "constraints_result": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:constraints:ConstraintCheckResult", | |
| "properties": { | |
| "constraint": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:constraints:Constraint", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "fulfilled": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ContentPackInstallationRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:contentpacks:responses:ContentPackInstallationRequest", | |
| "properties": { | |
| "parameters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:contentpacks:model:entities:references:ValueReference", | |
| "properties": { | |
| "@value": { | |
| "type": "any" | |
| }, | |
| "@type": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| }, | |
| "comment": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/content_packs", | |
| "operations": [ | |
| { | |
| "summary": "Upload a content pack", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createContentPack", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "Request body", | |
| "description": "Content pack", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ContentPack" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid content pack" | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while saving content pack" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs", | |
| "operations": [ | |
| { | |
| "summary": "List available content packs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listContentPacks", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackList", | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/latest", | |
| "operations": [ | |
| { | |
| "summary": "List latest available content packs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listLatestContentPacks", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackList", | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete all revisions of a content pack", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteContentPack", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content Pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid content pack" | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while saving content pack" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}", | |
| "operations": [ | |
| { | |
| "summary": "List all revisions of a content pack", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listContentPackRevisions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackRevisions", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/installations", | |
| "operations": [ | |
| { | |
| "summary": "Get details about the installations of a content pack", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listContentPackInstallationsById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackInstallationsResponse", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/installations/{installationId}", | |
| "operations": [ | |
| { | |
| "summary": "Uninstall a content pack installation", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteContentPackInstallationById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "installationId", | |
| "description": "Installation ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/installations/{installationId}/uninstall_details", | |
| "operations": [ | |
| { | |
| "summary": "Get details about which entities will actually be uninstalled", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "uninstallDetails", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackUninstallDetails", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "installationId", | |
| "description": "Installation ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/{revision}", | |
| "operations": [ | |
| { | |
| "summary": "Delete one revision of a content pack", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteContentPack", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content Pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "revision", | |
| "description": "Content Pack revision", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid content pack" | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Error while saving content pack" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/{revision}", | |
| "operations": [ | |
| { | |
| "summary": "Get a revision of a content pack", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getContentPackRevisions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackResponse", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "revision", | |
| "description": "Content pack revision", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/{revision}/download", | |
| "operations": [ | |
| { | |
| "summary": "Download a revision of a content pack", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "downloadContentPackRevisions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPack", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "revision", | |
| "description": "Content pack revision", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/content_packs/{contentPackId}/{revision}/installations", | |
| "operations": [ | |
| { | |
| "summary": "Install a revision of a content pack", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "installContentPack", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ContentPackInstallation", | |
| "parameters": [ | |
| { | |
| "name": "contentPackId", | |
| "description": "Content pack ID", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "ModelId" | |
| }, | |
| { | |
| "name": "revision", | |
| "description": "Content pack revision", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "installation request", | |
| "description": "Content pack installation request", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ContentPackInstallationRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "Error loading content packs" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/content_packs" | |
| } | |
| { | |
| "models": { | |
| "DebugEvent": { | |
| "id": "urn:jsonschema:org:graylog2:system:debug:DebugEvent", | |
| "properties": { | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "text": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/debug/events/cluster", | |
| "operations": [ | |
| { | |
| "summary": "Create and send a cluster debug event.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "generateClusterDebugEvent", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "text", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": "Cluster Test", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/debug/events/cluster", | |
| "operations": [ | |
| { | |
| "summary": "Show last received cluster debug event.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showLastClusterDebugEvent", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DebugEvent", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/debug/events/local", | |
| "operations": [ | |
| { | |
| "summary": "Create and send a local debug event.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "generateDebugEvent", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "text", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": "Local Test", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/debug/events/local", | |
| "operations": [ | |
| { | |
| "summary": "Show last received local debug event.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "showLastDebugEvent", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DebugEvent", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/debug/events" | |
| } | |
| { | |
| "models": { | |
| "DeflectorSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:deflector:responses:DeflectorSummary", | |
| "properties": { | |
| "is_up": { | |
| "type": "boolean" | |
| }, | |
| "current_target": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/deflector", | |
| "operations": [ | |
| { | |
| "summary": "Get current deflector status", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "deprecatedDeflector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DeflectorSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/deflector/cycle", | |
| "operations": [ | |
| { | |
| "summary": "Cycle deflector to new/next index", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "deprecatedCycle", | |
| "type": "void", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/deflector/{indexSetId}", | |
| "operations": [ | |
| { | |
| "summary": "Get current deflector status in index set", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "deflector", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DeflectorSummary", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/deflector/{indexSetId}/cycle", | |
| "operations": [ | |
| { | |
| "summary": "Cycle deflector to new/next index in index set", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "cycle", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/deflector" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/fields", | |
| "operations": [ | |
| { | |
| "summary": "Get list of message fields that exist", | |
| "notes": "This operation is comparably fast because it reads directly from the indexer mapping.", | |
| "method": "GET", | |
| "nickname": "fields", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "description": "Maximum number of fields to return. Set to 0 for all fields.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/fields" | |
| } | |
| { | |
| "models": { | |
| "DisplayGettingStarted": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:DisplayGettingStarted", | |
| "properties": { | |
| "show": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/gettingstarted", | |
| "operations": [ | |
| { | |
| "summary": "Check whether to display the Getting started guide for this version", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "displayGettingStarted", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DisplayGettingStarted", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/gettingstarted/dismiss", | |
| "operations": [ | |
| { | |
| "summary": "Dismiss auto-showing getting started guide for this version", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "dismissGettingStarted", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/gettingstarted" | |
| } | |
| { | |
| "models": { | |
| "GrokPatternList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:GrokPatternList", | |
| "properties": { | |
| "patterns": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:grok:GrokPattern", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "pattern": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "GrokPattern": { | |
| "id": "urn:jsonschema:org:graylog2:grok:GrokPattern", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "pattern": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "GrokPatternTestRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:grokpattern:requests:GrokPatternTestRequest", | |
| "properties": { | |
| "grok_pattern": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:grok:GrokPattern", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "pattern": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "sampleData": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/grok", | |
| "operations": [ | |
| { | |
| "summary": "Get all existing grok patterns", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listGrokPatterns", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "GrokPatternList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok", | |
| "operations": [ | |
| { | |
| "summary": "Add a list of new patterns", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "bulkUpdatePatterns", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "patterns", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "GrokPatternList" | |
| }, | |
| { | |
| "name": "replace", | |
| "description": "Replace all patterns with the new ones.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok", | |
| "operations": [ | |
| { | |
| "summary": "Add a list of new patterns", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "bulkUpdatePatternsFromTextFile", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "patterns", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "InputStream" | |
| }, | |
| { | |
| "name": "replace", | |
| "description": "Replace all patterns with the new ones.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok", | |
| "operations": [ | |
| { | |
| "summary": "Add a new named pattern", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createPattern", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "pattern", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "GrokPattern" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok/paginated", | |
| "operations": [ | |
| { | |
| "summary": "Get existing grok patterns paged", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPage", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok/test", | |
| "operations": [ | |
| { | |
| "summary": "Test pattern with sample data", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "testPattern", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "pattern", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "GrokPatternTestRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok/{patternId}", | |
| "operations": [ | |
| { | |
| "summary": "Update an existing pattern", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updatePattern", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "GrokPattern", | |
| "parameters": [ | |
| { | |
| "name": "patternId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "pattern", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "GrokPattern" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok/{patternId}", | |
| "operations": [ | |
| { | |
| "summary": "Get the existing grok pattern", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listPattern", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "GrokPattern", | |
| "parameters": [ | |
| { | |
| "name": "patternId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/grok/{patternId}", | |
| "operations": [ | |
| { | |
| "summary": "Remove an existing pattern by id", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "removePattern", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "patternId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/grok" | |
| } | |
| { | |
| "models": { | |
| "IndexRangeSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "IndexRangesResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangesResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "ranges": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indexer:responses:IndexRangeSummary", | |
| "properties": { | |
| "index_name": { | |
| "type": "string" | |
| }, | |
| "begin": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "end": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "calculated_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "took_ms": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indices/ranges", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all index ranges", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexRangesResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/ranges/index_set/{indexSetId}/rebuild", | |
| "operations": [ | |
| { | |
| "summary": "Rebuild/sync index range information for the given index set.", | |
| "notes": "This triggers a systemjob that scans every index in the given index set and stores meta information about what indices contain messages in what timeranges. It atomically overwrites already existing meta information.", | |
| "method": "POST", | |
| "nickname": "rebuildIndexSet", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "indexSetId", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 202, | |
| "message": "Rebuild/sync systemjob triggered." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/ranges/rebuild", | |
| "operations": [ | |
| { | |
| "summary": "Rebuild/sync index range information.", | |
| "notes": "This triggers a systemjob that scans every index and stores meta information about what indices contain messages in what timeranges. It atomically overwrites already existing meta information.", | |
| "method": "POST", | |
| "nickname": "rebuild", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 202, | |
| "message": "Rebuild/sync systemjob triggered." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/ranges/{index: [a-z_0-9-]+}/rebuild", | |
| "operations": [ | |
| { | |
| "summary": "Rebuild/sync index range information.", | |
| "notes": "This triggers a system job that scans an index and stores meta information about what indices contain messages in what time ranges. It atomically overwrites already existing meta information.", | |
| "method": "POST", | |
| "nickname": "rebuildIndex", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "The name of the Graylog-managed Elasticsearch index", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 202, | |
| "message": "Rebuild/sync system job triggered." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/ranges/{index: [a-z_0-9]+}", | |
| "operations": [ | |
| { | |
| "summary": "Show single index range", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "show", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexRangeSummary", | |
| "parameters": [ | |
| { | |
| "name": "index", | |
| "description": "The name of the Graylog-managed Elasticsearch index", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/indices/ranges" | |
| } | |
| { | |
| "models": { | |
| "IndexSetUpdateRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:requests:IndexSetUpdateRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "writable": { | |
| "type": "boolean" | |
| }, | |
| "shards": { | |
| "type": "integer" | |
| }, | |
| "replicas": { | |
| "type": "integer" | |
| }, | |
| "rotation_strategy_class": { | |
| "type": "string" | |
| }, | |
| "rotation_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:rotation:RotationStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "retention_strategy_class": { | |
| "type": "string" | |
| }, | |
| "retention_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:retention:RetentionStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "index_optimization_max_num_segments": { | |
| "type": "integer" | |
| }, | |
| "index_optimization_disabled": { | |
| "type": "boolean" | |
| }, | |
| "field_type_refresh_interval": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| } | |
| } | |
| }, | |
| "IndexSetStats": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:responses:IndexSetStats", | |
| "properties": { | |
| "indices": { | |
| "type": "integer" | |
| }, | |
| "documents": { | |
| "type": "integer" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "IndexSetSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:responses:IndexSetSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "default": { | |
| "type": "boolean" | |
| }, | |
| "writable": { | |
| "type": "boolean" | |
| }, | |
| "index_prefix": { | |
| "type": "string" | |
| }, | |
| "shards": { | |
| "type": "integer" | |
| }, | |
| "replicas": { | |
| "type": "integer" | |
| }, | |
| "rotation_strategy_class": { | |
| "type": "string" | |
| }, | |
| "rotation_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:rotation:RotationStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "retention_strategy_class": { | |
| "type": "string" | |
| }, | |
| "retention_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:retention:RetentionStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "creation_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "index_analyzer": { | |
| "type": "string" | |
| }, | |
| "index_optimization_max_num_segments": { | |
| "type": "integer" | |
| }, | |
| "index_optimization_disabled": { | |
| "type": "boolean" | |
| }, | |
| "field_type_refresh_interval": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "index_template_type": { | |
| "type": "string", | |
| "enum": [ | |
| "messages", | |
| "events", | |
| "gim_v1" | |
| ] | |
| } | |
| } | |
| }, | |
| "IndexSetResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:responses:IndexSetResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "index_sets": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:responses:IndexSetSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "default": { | |
| "type": "boolean" | |
| }, | |
| "writable": { | |
| "type": "boolean" | |
| }, | |
| "index_prefix": { | |
| "type": "string" | |
| }, | |
| "shards": { | |
| "type": "integer" | |
| }, | |
| "replicas": { | |
| "type": "integer" | |
| }, | |
| "rotation_strategy_class": { | |
| "type": "string" | |
| }, | |
| "rotation_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:rotation:RotationStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "retention_strategy_class": { | |
| "type": "string" | |
| }, | |
| "retention_strategy": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:retention:RetentionStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "creation_date": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "index_analyzer": { | |
| "type": "string" | |
| }, | |
| "index_optimization_max_num_segments": { | |
| "type": "integer" | |
| }, | |
| "index_optimization_disabled": { | |
| "type": "boolean" | |
| }, | |
| "field_type_refresh_interval": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "index_template_type": { | |
| "type": "string", | |
| "enum": [ | |
| "messages", | |
| "events", | |
| "gim_v1" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "stats": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:indexer:responses:IndexSetStats", | |
| "properties": { | |
| "indices": { | |
| "type": "integer" | |
| }, | |
| "documents": { | |
| "type": "integer" | |
| }, | |
| "size": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indices/index_sets", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all index sets", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetResponse", | |
| "parameters": [ | |
| { | |
| "name": "skip", | |
| "description": "The number of elements to skip (offset).", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "0", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "limit", | |
| "description": "The maximum number of elements to return.", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "0", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "stats", | |
| "description": "Include index set stats.", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets", | |
| "operations": [ | |
| { | |
| "summary": "Create index set", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "save", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetSummary", | |
| "parameters": [ | |
| { | |
| "name": "Index set configuration", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "IndexSetSummary" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/stats", | |
| "operations": [ | |
| { | |
| "summary": "Get stats of all index sets", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "globalStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetStats", | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Get index set", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetSummary", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| }, | |
| { | |
| "code": 404, | |
| "message": "Index set not found" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Update index set", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetSummary", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "Index set configuration", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "IndexSetUpdateRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| }, | |
| { | |
| "code": 409, | |
| "message": "Mismatch of IDs in URI path and payload" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete index set", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "delete_indices", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "true", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| }, | |
| { | |
| "code": 404, | |
| "message": "Index set not found" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/{id}/default", | |
| "operations": [ | |
| { | |
| "summary": "Set default index set", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "setDefault", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetSummary", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/index_sets/{id}/stats", | |
| "operations": [ | |
| { | |
| "summary": "Get index set statistics", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "indexSetStatistics", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "IndexSetStats", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 403, | |
| "message": "Unauthorized" | |
| }, | |
| { | |
| "code": 404, | |
| "message": "Index set not found" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/indices/index_sets" | |
| } | |
| { | |
| "models": { | |
| "RetentionStrategies": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RetentionStrategies", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "strategies": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RetentionStrategyDescription", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:retention:RetentionStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "json_schema": { | |
| "type": "object", | |
| "id": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "$ref": { | |
| "type": "string" | |
| }, | |
| "$schema": { | |
| "type": "string" | |
| }, | |
| "disallow": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "readonly": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "extends": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "RetentionStrategyDescription": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RetentionStrategyDescription", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:retention:RetentionStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "json_schema": { | |
| "type": "object", | |
| "id": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "$ref": { | |
| "type": "string" | |
| }, | |
| "$schema": { | |
| "type": "string" | |
| }, | |
| "disallow": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "readonly": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "extends": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indices/retention/strategies", | |
| "operations": [ | |
| { | |
| "summary": "List available retention strategies", | |
| "notes": "This resource returns a list of all available retention strategies on this Graylog node.", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RetentionStrategies", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/retention/strategies/{strategy}", | |
| "operations": [ | |
| { | |
| "summary": "Show JSON schema for configuration of given retention strategies", | |
| "notes": "This resource returns a JSON schema for the configuration of the given retention strategy.", | |
| "method": "GET", | |
| "nickname": "configSchema", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RetentionStrategyDescription", | |
| "parameters": [ | |
| { | |
| "name": "strategy", | |
| "description": "The name of the retention strategy", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/indices/retention" | |
| } | |
| { | |
| "models": { | |
| "RotationStrategies": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RotationStrategies", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "strategies": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RotationStrategyDescription", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:rotation:RotationStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "json_schema": { | |
| "type": "object", | |
| "id": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "$ref": { | |
| "type": "string" | |
| }, | |
| "$schema": { | |
| "type": "string" | |
| }, | |
| "disallow": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "readonly": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "extends": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "RotationStrategyDescription": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:indices:RotationStrategyDescription", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "default_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:indexer:rotation:RotationStrategyConfig", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "json_schema": { | |
| "type": "object", | |
| "id": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "$ref": { | |
| "type": "string" | |
| }, | |
| "$schema": { | |
| "type": "string" | |
| }, | |
| "disallow": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| }, | |
| "required": { | |
| "type": "boolean" | |
| }, | |
| "readonly": { | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "extends": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "$ref": "urn:jsonschema:com:fasterxml:jackson:module:jsonSchema:JsonSchema" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/indices/rotation/strategies", | |
| "operations": [ | |
| { | |
| "summary": "List available rotation strategies", | |
| "notes": "This resource returns a list of all available rotation strategies on this Graylog node.", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RotationStrategies", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/indices/rotation/strategies/{strategy}", | |
| "operations": [ | |
| { | |
| "summary": "Show JSON schema for configuration of given rotation strategies", | |
| "notes": "This resource returns a JSON schema for the configuration of the given rotation strategy.", | |
| "method": "GET", | |
| "nickname": "configSchema", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "RotationStrategyDescription", | |
| "parameters": [ | |
| { | |
| "name": "strategy", | |
| "description": "The name of the rotation strategy", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/indices/rotation" | |
| } | |
| { | |
| "models": { | |
| "InputStatesList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputStatesList", | |
| "properties": { | |
| "states": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputStateSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "detailed_message": { | |
| "type": "string" | |
| }, | |
| "message_input": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputSummary", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "global": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "static_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "node": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "InputStateSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputStateSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "state": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "detailed_message": { | |
| "type": "string" | |
| }, | |
| "message_input": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputSummary", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "global": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "static_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "node": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "InputCreated": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputCreated", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "InputDeleted": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputDeleted", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/inputstates", | |
| "operations": [ | |
| { | |
| "summary": "Get all input states of this node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputStatesList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputstates/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Get input state for specified input id on this node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputStateSummary", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputstates/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "(Re-)Start specified input on this node", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "start", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputCreated", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputstates/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Stop specified input on this node", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "stop", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputDeleted", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/inputstates" | |
| } | |
| { | |
| "models": { | |
| "InputSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputSummary", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "global": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "static_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "node": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "InputsList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputsList", | |
| "properties": { | |
| "inputs": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputSummary", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "global": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "attributes": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "static_fields": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "node": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "InputCreateRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:requests:InputCreateRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "global": { | |
| "type": "boolean" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "node": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/inputs", | |
| "operations": [ | |
| { | |
| "summary": "Launch input on this node", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "InputCreateRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input type registered" | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid configuration" | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Type is exclusive and already has input running" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs", | |
| "operations": [ | |
| { | |
| "summary": "Get all inputs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputsList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Terminate input on this node", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "terminate", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Get information of a single input on this node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputSummary", | |
| "parameters": [ | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs/{inputId}", | |
| "operations": [ | |
| { | |
| "summary": "Update input on this node", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "InputCreateRequest" | |
| }, | |
| { | |
| "name": "inputId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input on this node." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid input configuration." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/inputs" | |
| } | |
| { | |
| "models": { | |
| "InputTypesSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputTypesSummary", | |
| "properties": { | |
| "types": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "InputTypeInfo": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:inputs:responses:InputTypeInfo", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "is_exclusive": { | |
| "type": "boolean" | |
| }, | |
| "requested_configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "link_to_docs": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/inputs/types", | |
| "operations": [ | |
| { | |
| "summary": "Get all available input types of this node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "types", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputTypesSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs/types/all", | |
| "operations": [ | |
| { | |
| "summary": "Get information about all input types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/inputs/types/{inputType}", | |
| "operations": [ | |
| { | |
| "summary": "Get information about a single input type", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "info", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "InputTypeInfo", | |
| "parameters": [ | |
| { | |
| "name": "inputType", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such input type registered." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/inputs/types" | |
| } | |
| { | |
| "models": { | |
| "SystemJobSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:SystemJobSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "info": { | |
| "type": "string" | |
| }, | |
| "node_id": { | |
| "type": "string" | |
| }, | |
| "started_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "percent_complete": { | |
| "type": "integer" | |
| }, | |
| "is_cancelable": { | |
| "type": "boolean" | |
| }, | |
| "provides_progress": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "TriggerRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:jobs:requests:TriggerRequest", | |
| "properties": { | |
| "job_name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/jobs", | |
| "operations": [ | |
| { | |
| "summary": "Trigger new job", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "trigger", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "TriggerRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 202, | |
| "message": "Job accepted." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "There is no such systemjob type." | |
| }, | |
| { | |
| "code": 403, | |
| "message": "Maximum concurrency level of this systemjob type reached." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/jobs", | |
| "operations": [ | |
| { | |
| "summary": "List currently running jobs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/jobs/{jobId}", | |
| "operations": [ | |
| { | |
| "summary": "Cancel running job", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "cancel", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/jobs/{jobId}", | |
| "operations": [ | |
| { | |
| "summary": "Get information of a specific currently running job", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemJobSummary", | |
| "parameters": [ | |
| { | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Job not found." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/jobs" | |
| } | |
| { | |
| "models": { | |
| "JournalSummaryResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:responses:JournalSummaryResponse", | |
| "properties": { | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "append_events_per_second": { | |
| "type": "integer" | |
| }, | |
| "read_events_per_second": { | |
| "type": "integer" | |
| }, | |
| "uncommitted_journal_entries": { | |
| "type": "integer" | |
| }, | |
| "journal_size": { | |
| "type": "any" | |
| }, | |
| "journal_size_limit": { | |
| "type": "any" | |
| }, | |
| "number_of_segments": { | |
| "type": "integer" | |
| }, | |
| "oldest_segment": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "journal_config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:responses:KafkaJournalConfigurationSummary", | |
| "properties": { | |
| "directory": { | |
| "type": "string" | |
| }, | |
| "segment_size": { | |
| "type": "integer" | |
| }, | |
| "segment_age": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "max_size": { | |
| "type": "integer" | |
| }, | |
| "max_age": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| }, | |
| "flush_interval": { | |
| "type": "integer" | |
| }, | |
| "flush_age": { | |
| "type": "integer", | |
| "format": "utc-millisec" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/journal", | |
| "operations": [ | |
| { | |
| "summary": "Get current state of the journal on this node.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "show", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JournalSummaryResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/journal" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/lbstatus", | |
| "operations": [ | |
| { | |
| "summary": "Get status of this Graylog server node for load balancers. Returns ALIVE with HTTP 200, DEAD with HTTP 503, or THROTTLED with HTTP 429.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "status", | |
| "produces": [ | |
| "text/plain" | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lbstatus/override/{status}", | |
| "operations": [ | |
| { | |
| "summary": "Override load balancer status of this Graylog server node. Next lifecycle change will override it again to its default. Set to ALIVE, DEAD, or THROTTLED.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "override", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "status", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/lbstatus" | |
| } | |
| { | |
| "models": { | |
| "SubsystemSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:SubsystemSummary", | |
| "properties": { | |
| "subsystems": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:SingleSubsystemSummary", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "categories": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "level": { | |
| "type": "string" | |
| }, | |
| "level_syslog": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "LoggersSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:LoggersSummary", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "loggers": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:SingleLoggerSummary", | |
| "properties": { | |
| "level": { | |
| "type": "string" | |
| }, | |
| "level_syslog": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "LogMessagesSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:LogMessagesSummary", | |
| "properties": { | |
| "messages": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:loggers:responses:InternalLogMessage", | |
| "properties": { | |
| "message": { | |
| "type": "string" | |
| }, | |
| "class_name": { | |
| "type": "string" | |
| }, | |
| "level": { | |
| "type": "string" | |
| }, | |
| "marker": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "throwable": { | |
| "type": "string" | |
| }, | |
| "thread_name": { | |
| "type": "string" | |
| }, | |
| "context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/loggers", | |
| "operations": [ | |
| { | |
| "summary": "List all loggers and their current levels", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "loggers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LoggersSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/loggers/messages/recent", | |
| "operations": [ | |
| { | |
| "summary": "Get recent internal log messages", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "messages", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LogMessagesSummary", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "description": "How many log messages should be returned", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "500", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "level", | |
| "description": "Which log level (or higher) should the messages have", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "ALL", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "Memory appender is disabled." | |
| }, | |
| { | |
| "code": 500, | |
| "message": "Memory appender is broken." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/loggers/subsystems", | |
| "operations": [ | |
| { | |
| "summary": "List all logger subsystems and their current levels", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "subsystems", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SubsystemSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/loggers/subsystems/{subsystem}/level/{level}", | |
| "operations": [ | |
| { | |
| "summary": "Set the loglevel of a whole subsystem", | |
| "notes": "Provided level is falling back to DEBUG if it does not exist", | |
| "method": "PUT", | |
| "nickname": "setSubsystemLoggerLevel", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "subsystem", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "level", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such subsystem." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/loggers/{loggerName}/level/{level}", | |
| "operations": [ | |
| { | |
| "summary": "Set the loglevel of a single logger", | |
| "notes": "Provided level is falling back to DEBUG if it does not exist", | |
| "method": "PUT", | |
| "nickname": "setSingleLoggerLevel", | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "loggerName", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "level", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/loggers" | |
| } | |
| { | |
| "models": { | |
| "CachesPage": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:lookup:LookupTableResource:CachesPage", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "caches": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:CacheApi", | |
| "properties": { | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupCacheConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "ErrorStates": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:ErrorStates", | |
| "properties": { | |
| "caches": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "data_adapters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "tables": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "LookupTableApi": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:LookupTableApi", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "default_single_value": { | |
| "type": "string" | |
| }, | |
| "default_multi_value": { | |
| "type": "string" | |
| }, | |
| "cache_id": { | |
| "type": "string" | |
| }, | |
| "data_adapter_id": { | |
| "type": "string" | |
| }, | |
| "default_single_value_type": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "NUMBER", | |
| "OBJECT", | |
| "BOOLEAN", | |
| "NULL" | |
| ] | |
| }, | |
| "default_multi_value_type": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "NUMBER", | |
| "OBJECT", | |
| "BOOLEAN", | |
| "NULL" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DataAdapterPage": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:lookup:LookupTableResource:DataAdapterPage", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "data_adapters": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:DataAdapterApi", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupDataAdapterConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "custom_error_ttl_unit": { | |
| "type": "string", | |
| "enum": [ | |
| "NANOSECONDS", | |
| "MICROSECONDS", | |
| "MILLISECONDS", | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "custom_error_ttl": { | |
| "type": "integer" | |
| }, | |
| "custom_error_ttl_enabled": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "CacheApi": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:CacheApi", | |
| "properties": { | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupCacheConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ErrorStatesRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:ErrorStatesRequest", | |
| "properties": { | |
| "caches": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "data_adapters": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "tables": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ValidationResult": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:rest:ValidationResult", | |
| "properties": { | |
| "errors": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "error_context": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "failed": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "LookupTablePage": { | |
| "id": "urn:jsonschema:org:graylog2:rest:resources:system:lookup:LookupTableResource:LookupTablePage", | |
| "properties": { | |
| "query": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "per_page": { | |
| "type": "integer" | |
| }, | |
| "page": { | |
| "type": "integer" | |
| }, | |
| "count": { | |
| "type": "integer" | |
| }, | |
| "lookup_tables": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:LookupTableApi", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "default_single_value": { | |
| "type": "string" | |
| }, | |
| "default_multi_value": { | |
| "type": "string" | |
| }, | |
| "cache_id": { | |
| "type": "string" | |
| }, | |
| "data_adapter_id": { | |
| "type": "string" | |
| }, | |
| "default_single_value_type": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "NUMBER", | |
| "OBJECT", | |
| "BOOLEAN", | |
| "NULL" | |
| ] | |
| }, | |
| "default_multi_value_type": { | |
| "type": "string", | |
| "enum": [ | |
| "STRING", | |
| "NUMBER", | |
| "OBJECT", | |
| "BOOLEAN", | |
| "NULL" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "caches": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:CacheApi", | |
| "properties": { | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupCacheConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "data_adapters": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:DataAdapterApi", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupDataAdapterConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "custom_error_ttl_unit": { | |
| "type": "string", | |
| "enum": [ | |
| "NANOSECONDS", | |
| "MICROSECONDS", | |
| "MILLISECONDS", | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "custom_error_ttl": { | |
| "type": "integer" | |
| }, | |
| "custom_error_ttl_enabled": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "DataAdapterApi": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:lookup:DataAdapterApi", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "config": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:plugin:lookup:LookupDataAdapterConfiguration", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| }, | |
| "custom_error_ttl_unit": { | |
| "type": "string", | |
| "enum": [ | |
| "NANOSECONDS", | |
| "MICROSECONDS", | |
| "MILLISECONDS", | |
| "SECONDS", | |
| "MINUTES", | |
| "HOURS", | |
| "DAYS" | |
| ] | |
| }, | |
| "custom_error_ttl": { | |
| "type": "integer" | |
| }, | |
| "custom_error_ttl_enabled": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/lookup/adapters", | |
| "operations": [ | |
| { | |
| "summary": "List available data adapters", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "adapters", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DataAdapterPage", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "desc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters", | |
| "operations": [ | |
| { | |
| "summary": "Create a new data adapter", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createAdapter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DataAdapterApi", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "DataAdapterApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validate the data adapter config", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateAdapter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "DataAdapterApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "List the given data adapter", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getAdapter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DataAdapterApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the given data adapter", | |
| "notes": "The data adapter cannot be in use by any lookup table, otherwise the request will fail.", | |
| "method": "DELETE", | |
| "nickname": "deleteAdapter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DataAdapterApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Update the given data adapter settings", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateAdapter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "DataAdapterApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "DataAdapterApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/adapters/{name}/query", | |
| "operations": [ | |
| { | |
| "summary": "Query a lookup table", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "performAdapterLookup", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupResult", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "key", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "If the adapter cannot be found (if it failed or doesn't exist at all)" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches", | |
| "operations": [ | |
| { | |
| "summary": "List available caches", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "caches", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CachesPage", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "desc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches", | |
| "operations": [ | |
| { | |
| "summary": "Create a new cache", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createCache", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CacheApi", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CacheApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validate the cache config", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateCache", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CacheApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the given cache", | |
| "notes": "The cache cannot be in use by any lookup table, otherwise the request will fail.", | |
| "method": "DELETE", | |
| "nickname": "deleteCache", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CacheApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Update the given cache settings", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateCache", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CacheApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CacheApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/caches/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "List the given cache", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getCache", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "CacheApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/errorstates", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the runtime error states of the given lookup tables, caches and adapters", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "errorStates", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ErrorStates", | |
| "parameters": [ | |
| { | |
| "name": "request", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ErrorStatesRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables", | |
| "operations": [ | |
| { | |
| "summary": "Create a new lookup table", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "createTable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupTableApi", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "LookupTableApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables", | |
| "operations": [ | |
| { | |
| "summary": "List configured lookup tables", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "tables", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupTablePage", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "desc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "resolve", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/validate", | |
| "operations": [ | |
| { | |
| "summary": "Validate the lookup table config", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "validateTable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ValidationResult", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "LookupTableApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Update the given lookup table", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateTable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupTableApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "LookupTableApi" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Delete the lookup table", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "removeTable", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupTableApi", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/{idOrName}", | |
| "operations": [ | |
| { | |
| "summary": "Retrieve the named lookup table", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupTablePage", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "resolve", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "false", | |
| "type": "Boolean" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/{idOrName}/purge", | |
| "operations": [ | |
| { | |
| "summary": "Purge lookup table cache", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "performPurge", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "idOrName", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "key", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/tables/{name}/query", | |
| "operations": [ | |
| { | |
| "summary": "Query a lookup table", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "performLookup", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "LookupResult", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "key", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/types/adapters", | |
| "operations": [ | |
| { | |
| "summary": "List available data adapter types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "availableAdapterTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/lookup/types/caches", | |
| "operations": [ | |
| { | |
| "summary": "List available caches types", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "availableCacheTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/lookup" | |
| } | |
| { | |
| "models": { | |
| "MessageProcessorsConfigWithDescriptors": { | |
| "id": "urn:jsonschema:org:graylog2:messageprocessors:MessageProcessorsConfigWithDescriptors", | |
| "properties": { | |
| "processor_order": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:messageprocessors:MessageProcessorDescriptor", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| }, | |
| "class_name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "disabled_processors": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/messageprocessors/config", | |
| "operations": [ | |
| { | |
| "summary": "Get message processor configuration", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "config", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MessageProcessorsConfigWithDescriptors", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/messageprocessors/config", | |
| "operations": [ | |
| { | |
| "summary": "Update message processor configuration", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateConfig", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MessageProcessorsConfigWithDescriptors", | |
| "parameters": [ | |
| { | |
| "name": "config", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MessageProcessorsConfigWithDescriptors" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/messageprocessors" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/messages", | |
| "operations": [ | |
| { | |
| "summary": "Get internal Graylog system messages", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "all", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "Page", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "Integer" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/messages" | |
| } | |
| { | |
| "models": { | |
| "MetricsSummaryResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:metrics:responses:MetricsSummaryResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "metrics": { | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "MetricNamesResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:metrics:responses:MetricNamesResponse", | |
| "properties": { | |
| "names": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "MetricsReadRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:metrics:requests:MetricsReadRequest", | |
| "properties": { | |
| "metrics": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/metrics", | |
| "operations": [ | |
| { | |
| "summary": "Get all metrics", | |
| "notes": "Note that this might return a huge result set.", | |
| "method": "GET", | |
| "nickname": "metrics", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MetricRegistry", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/metrics/multiple", | |
| "operations": [ | |
| { | |
| "summary": "Get the values of multiple metrics at once", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "multipleMetrics", | |
| "type": "MetricsSummaryResponse", | |
| "parameters": [ | |
| { | |
| "name": "Requested metrics", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "MetricsReadRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Malformed body" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/metrics/names", | |
| "operations": [ | |
| { | |
| "summary": "Get all metrics keys/names", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "metricNames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MetricNamesResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/metrics/namespace/{namespace}", | |
| "operations": [ | |
| { | |
| "summary": "Get all metrics of a namespace", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "byNamespace", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "MetricsSummaryResponse", | |
| "parameters": [ | |
| { | |
| "name": "namespace", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such metric namespace" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/metrics/{metricName}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single metric", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "singleMetric", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Metric", | |
| "parameters": [ | |
| { | |
| "name": "metricName", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such metric" | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/metrics" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/metrics/metricName/history" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/notifications", | |
| "operations": [ | |
| { | |
| "summary": "Get all active notifications", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listNotifications", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/notifications/{notificationType}", | |
| "operations": [ | |
| { | |
| "summary": "Delete a notification", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteNotification", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "notificationType", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such notification type." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/notifications" | |
| } | |
| { | |
| "models": { | |
| "OutputSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:outputs:responses:OutputSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "OutputListResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:outputs:OutputListResponse", | |
| "properties": { | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "outputs": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:outputs:responses:OutputSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Output": { | |
| "id": "urn:jsonschema:org:graylog2:plugin:streams:Output", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "creator_user_id": { | |
| "type": "string" | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CreateOutputRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:streams:outputs:requests:CreateOutputRequest", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "configuration": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "streams": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "content_pack": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/outputs", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all outputs", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OutputListResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/outputs", | |
| "operations": [ | |
| { | |
| "summary": "Create an output", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CreateOutputRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Invalid output specification in input." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/outputs/available", | |
| "operations": [ | |
| { | |
| "summary": "Get all available output modules", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "available", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/outputs/{outputId}", | |
| "operations": [ | |
| { | |
| "summary": "Get specific output", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OutputSummary", | |
| "parameters": [ | |
| { | |
| "name": "outputId", | |
| "description": "The id of the output we want.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such output on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/outputs/{outputId}", | |
| "operations": [ | |
| { | |
| "summary": "Update output", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Output", | |
| "parameters": [ | |
| { | |
| "name": "outputId", | |
| "description": "The id of the output that should be deleted", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "Map" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such output on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/outputs/{outputId}", | |
| "operations": [ | |
| { | |
| "summary": "Delete output", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "outputId", | |
| "description": "The id of the output that should be deleted", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "No such stream/output on this node." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/outputs" | |
| } | |
| { | |
| "models": { | |
| "ReaderPermissionResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:ReaderPermissionResponse", | |
| "properties": { | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/permissions", | |
| "operations": [ | |
| { | |
| "summary": "Get all available user permissions.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "permissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/permissions/reader/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Get the initial permissions assigned to a reader account", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "readerPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ReaderPermissionResponse", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/permissions" | |
| } | |
| { | |
| "models": { | |
| "PluginList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:plugins:responses:PluginList", | |
| "properties": { | |
| "plugins": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:plugins:responses:PluginMetaDataValue", | |
| "properties": { | |
| "unique_id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "author": { | |
| "type": "string" | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "required_version": { | |
| "type": "string" | |
| }, | |
| "required_capabilities": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "total": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/plugins", | |
| "operations": [ | |
| { | |
| "summary": "List all installed plugins on this node.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PluginList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/plugins" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/processing/pause", | |
| "operations": [ | |
| { | |
| "summary": "Pauses message processing", | |
| "notes": "If the message journal is enabled, incoming messages will be spooled on disk, if it is disabled, you might lose messages from inputs which cannot buffer themselves, like AMQP or Kafka-based inputs.", | |
| "method": "PUT", | |
| "nickname": "pauseProcessing", | |
| "type": "void", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/processing/resume", | |
| "operations": [ | |
| { | |
| "summary": "Resume message processing", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "resumeProcessing", | |
| "type": "void", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/processing" | |
| } | |
| { | |
| "models": { | |
| "ProcessingStatusSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:processing:ProcessingStatusSummary", | |
| "properties": { | |
| "receive_times": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:processing:ProcessingStatusSummary:ReceiveTimes", | |
| "properties": { | |
| "ingest": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "post_processing": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "post_indexing": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/processing/status", | |
| "operations": [ | |
| { | |
| "summary": "Get processing status summary from node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ProcessingStatusSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/processing/status/persisted", | |
| "operations": [ | |
| { | |
| "summary": "Get persisted processing status summary from node", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPersistedStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ProcessingStatusSummary", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/processing/status" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/serviceManager", | |
| "operations": [ | |
| { | |
| "summary": "List current status of ServiceManager", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "list", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Map", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/serviceManager" | |
| } | |
| { | |
| "models": { | |
| "SessionValidationResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:sessions:responses:SessionValidationResponse", | |
| "properties": { | |
| "is_valid": { | |
| "type": "boolean" | |
| }, | |
| "session_id": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/sessions", | |
| "operations": [ | |
| { | |
| "summary": "Validate an existing session", | |
| "notes": "Checks the session with the given ID: returns http status 204 (No Content) if session is valid.", | |
| "method": "GET", | |
| "nickname": "validateSession", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SessionValidationResponse", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/sessions", | |
| "operations": [ | |
| { | |
| "summary": "Create a new session", | |
| "notes": "This request creates a new session for a user or reactivates an existing session: the equivalent of logging in.", | |
| "method": "POST", | |
| "nickname": "newSession", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JsonNode", | |
| "parameters": [ | |
| { | |
| "name": "Login request", | |
| "description": "Credentials. The default implementation requires presence of two properties: 'username' and 'password'. However a plugin may customize which kind of credentials are accepted and therefore expect different properties.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "JsonNode" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/sessions/{sessionId}", | |
| "operations": [ | |
| { | |
| "summary": "Terminate an existing session", | |
| "notes": "Destroys the session with the given ID: the equivalent of logging out.", | |
| "method": "DELETE", | |
| "nickname": "terminateSession", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "sessionId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/sessions" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/shutdown/shutdown", | |
| "operations": [ | |
| { | |
| "summary": "Shutdown this node gracefully.", | |
| "notes": "Attempts to process all buffered and cached messages before exiting, shuts down inputs first to make sure that no new messages are accepted.", | |
| "method": "POST", | |
| "nickname": "shutdown", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/shutdown" | |
| } | |
| { | |
| "models": { | |
| "SystemStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:SystemStats", | |
| "properties": { | |
| "fs": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:fs:FsStats", | |
| "properties": { | |
| "filesystems": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:fs:FsStats:Filesystem", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "dev": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "type_name": { | |
| "type": "string" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| }, | |
| "disk_service_time": { | |
| "type": "number" | |
| }, | |
| "inodes_used_percent": { | |
| "type": "integer" | |
| }, | |
| "disk_write_bytes": { | |
| "type": "integer" | |
| }, | |
| "disk_queue": { | |
| "type": "number" | |
| }, | |
| "mount": { | |
| "type": "string" | |
| }, | |
| "sys_type_name": { | |
| "type": "string" | |
| }, | |
| "used_percent": { | |
| "type": "integer" | |
| }, | |
| "inodes_total": { | |
| "type": "integer" | |
| }, | |
| "inodes_free": { | |
| "type": "integer" | |
| }, | |
| "inodes_used": { | |
| "type": "integer" | |
| }, | |
| "disk_reads": { | |
| "type": "integer" | |
| }, | |
| "disk_writes": { | |
| "type": "integer" | |
| }, | |
| "disk_read_bytes": { | |
| "type": "integer" | |
| }, | |
| "available": { | |
| "type": "integer" | |
| }, | |
| "path": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "os": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:OsStats", | |
| "properties": { | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Memory", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| }, | |
| "free_percent": { | |
| "type": "integer" | |
| }, | |
| "actual_free": { | |
| "type": "integer" | |
| }, | |
| "actual_used": { | |
| "type": "integer" | |
| }, | |
| "used_percent": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "processor": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Processor", | |
| "properties": { | |
| "user": { | |
| "type": "integer" | |
| }, | |
| "vendor": { | |
| "type": "string" | |
| }, | |
| "sys": { | |
| "type": "integer" | |
| }, | |
| "idle": { | |
| "type": "integer" | |
| }, | |
| "mhz": { | |
| "type": "integer" | |
| }, | |
| "cores_per_socket": { | |
| "type": "integer" | |
| }, | |
| "cache_size": { | |
| "type": "integer" | |
| }, | |
| "total_sockets": { | |
| "type": "integer" | |
| }, | |
| "model": { | |
| "type": "string" | |
| }, | |
| "total_cores": { | |
| "type": "integer" | |
| }, | |
| "stolen": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "uptime": { | |
| "type": "integer" | |
| }, | |
| "load_average": { | |
| "type": "array", | |
| "items": { | |
| "type": "number" | |
| } | |
| }, | |
| "swap": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Swap", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "process": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats", | |
| "properties": { | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats:Memory", | |
| "properties": { | |
| "total_virtual": { | |
| "type": "integer" | |
| }, | |
| "resident": { | |
| "type": "integer" | |
| }, | |
| "share": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cpu": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats:Cpu", | |
| "properties": { | |
| "percent": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "sys": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "pid": { | |
| "type": "integer" | |
| }, | |
| "open_file_descriptors": { | |
| "type": "integer" | |
| }, | |
| "max_file_descriptors": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "network": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats", | |
| "properties": { | |
| "tcp": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:TcpStats", | |
| "properties": { | |
| "curr_estab": { | |
| "type": "integer" | |
| }, | |
| "passive_opens": { | |
| "type": "integer" | |
| }, | |
| "active_opens": { | |
| "type": "integer" | |
| }, | |
| "out_segs": { | |
| "type": "integer" | |
| }, | |
| "retrans_segs": { | |
| "type": "integer" | |
| }, | |
| "in_errs": { | |
| "type": "integer" | |
| }, | |
| "out_rsts": { | |
| "type": "integer" | |
| }, | |
| "in_segs": { | |
| "type": "integer" | |
| }, | |
| "attempt_fails": { | |
| "type": "integer" | |
| }, | |
| "estab_resets": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "primary_interface": { | |
| "type": "string" | |
| }, | |
| "interfaces": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:Interface", | |
| "properties": { | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "mtu": { | |
| "type": "integer" | |
| }, | |
| "interface_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:InterfaceStats", | |
| "properties": { | |
| "rx_errors": { | |
| "type": "integer" | |
| }, | |
| "rx_frame": { | |
| "type": "integer" | |
| }, | |
| "rx_dropped": { | |
| "type": "integer" | |
| }, | |
| "tx_packets": { | |
| "type": "integer" | |
| }, | |
| "rx_overruns": { | |
| "type": "integer" | |
| }, | |
| "rx_packets": { | |
| "type": "integer" | |
| }, | |
| "tx_overruns": { | |
| "type": "integer" | |
| }, | |
| "tx_carrier": { | |
| "type": "integer" | |
| }, | |
| "tx_collisions": { | |
| "type": "integer" | |
| }, | |
| "rx_bytes": { | |
| "type": "integer" | |
| }, | |
| "tx_bytes": { | |
| "type": "integer" | |
| }, | |
| "tx_dropped": { | |
| "type": "integer" | |
| }, | |
| "tx_errors": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "mac_address": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "jvm": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:jvm:JvmStats", | |
| "properties": { | |
| "spec_version": { | |
| "type": "string" | |
| }, | |
| "spec_vendor": { | |
| "type": "string" | |
| }, | |
| "start_time": { | |
| "type": "integer" | |
| }, | |
| "garbage_collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "mem": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:jvm:JvmStats:Memory", | |
| "properties": { | |
| "heap_init": { | |
| "type": "integer" | |
| }, | |
| "heap_max": { | |
| "type": "integer" | |
| }, | |
| "direct_memory_max": { | |
| "type": "integer" | |
| }, | |
| "non_heap_init": { | |
| "type": "integer" | |
| }, | |
| "non_heap_max": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "vm_vendor": { | |
| "type": "string" | |
| }, | |
| "spec_name": { | |
| "type": "string" | |
| }, | |
| "input_arguments": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "vm_version": { | |
| "type": "string" | |
| }, | |
| "vm_name": { | |
| "type": "string" | |
| }, | |
| "memory_pools": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "system_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "class_path": { | |
| "type": "string" | |
| }, | |
| "boot_class_path": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "JvmStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:jvm:JvmStats", | |
| "properties": { | |
| "spec_version": { | |
| "type": "string" | |
| }, | |
| "spec_vendor": { | |
| "type": "string" | |
| }, | |
| "start_time": { | |
| "type": "integer" | |
| }, | |
| "garbage_collectors": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "mem": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:jvm:JvmStats:Memory", | |
| "properties": { | |
| "heap_init": { | |
| "type": "integer" | |
| }, | |
| "heap_max": { | |
| "type": "integer" | |
| }, | |
| "direct_memory_max": { | |
| "type": "integer" | |
| }, | |
| "non_heap_init": { | |
| "type": "integer" | |
| }, | |
| "non_heap_max": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "vm_vendor": { | |
| "type": "string" | |
| }, | |
| "spec_name": { | |
| "type": "string" | |
| }, | |
| "input_arguments": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "vm_version": { | |
| "type": "string" | |
| }, | |
| "vm_name": { | |
| "type": "string" | |
| }, | |
| "memory_pools": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "system_properties": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "string" | |
| } | |
| }, | |
| "class_path": { | |
| "type": "string" | |
| }, | |
| "boot_class_path": { | |
| "type": "string" | |
| }, | |
| "version": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ProcessStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats", | |
| "properties": { | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats:Memory", | |
| "properties": { | |
| "total_virtual": { | |
| "type": "integer" | |
| }, | |
| "resident": { | |
| "type": "integer" | |
| }, | |
| "share": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "cpu": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:process:ProcessStats:Cpu", | |
| "properties": { | |
| "percent": { | |
| "type": "integer" | |
| }, | |
| "user": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "sys": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "pid": { | |
| "type": "integer" | |
| }, | |
| "open_file_descriptors": { | |
| "type": "integer" | |
| }, | |
| "max_file_descriptors": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "NetworkStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats", | |
| "properties": { | |
| "tcp": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:TcpStats", | |
| "properties": { | |
| "curr_estab": { | |
| "type": "integer" | |
| }, | |
| "passive_opens": { | |
| "type": "integer" | |
| }, | |
| "active_opens": { | |
| "type": "integer" | |
| }, | |
| "out_segs": { | |
| "type": "integer" | |
| }, | |
| "retrans_segs": { | |
| "type": "integer" | |
| }, | |
| "in_errs": { | |
| "type": "integer" | |
| }, | |
| "out_rsts": { | |
| "type": "integer" | |
| }, | |
| "in_segs": { | |
| "type": "integer" | |
| }, | |
| "attempt_fails": { | |
| "type": "integer" | |
| }, | |
| "estab_resets": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "primary_interface": { | |
| "type": "string" | |
| }, | |
| "interfaces": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:Interface", | |
| "properties": { | |
| "addresses": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "mtu": { | |
| "type": "integer" | |
| }, | |
| "interface_stats": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:network:NetworkStats:InterfaceStats", | |
| "properties": { | |
| "rx_errors": { | |
| "type": "integer" | |
| }, | |
| "rx_frame": { | |
| "type": "integer" | |
| }, | |
| "rx_dropped": { | |
| "type": "integer" | |
| }, | |
| "tx_packets": { | |
| "type": "integer" | |
| }, | |
| "rx_overruns": { | |
| "type": "integer" | |
| }, | |
| "rx_packets": { | |
| "type": "integer" | |
| }, | |
| "tx_overruns": { | |
| "type": "integer" | |
| }, | |
| "tx_carrier": { | |
| "type": "integer" | |
| }, | |
| "tx_collisions": { | |
| "type": "integer" | |
| }, | |
| "rx_bytes": { | |
| "type": "integer" | |
| }, | |
| "tx_bytes": { | |
| "type": "integer" | |
| }, | |
| "tx_dropped": { | |
| "type": "integer" | |
| }, | |
| "tx_errors": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "mac_address": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "OsStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:OsStats", | |
| "properties": { | |
| "memory": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Memory", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| }, | |
| "free_percent": { | |
| "type": "integer" | |
| }, | |
| "actual_free": { | |
| "type": "integer" | |
| }, | |
| "actual_used": { | |
| "type": "integer" | |
| }, | |
| "used_percent": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "processor": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Processor", | |
| "properties": { | |
| "user": { | |
| "type": "integer" | |
| }, | |
| "vendor": { | |
| "type": "string" | |
| }, | |
| "sys": { | |
| "type": "integer" | |
| }, | |
| "idle": { | |
| "type": "integer" | |
| }, | |
| "mhz": { | |
| "type": "integer" | |
| }, | |
| "cores_per_socket": { | |
| "type": "integer" | |
| }, | |
| "cache_size": { | |
| "type": "integer" | |
| }, | |
| "total_sockets": { | |
| "type": "integer" | |
| }, | |
| "model": { | |
| "type": "string" | |
| }, | |
| "total_cores": { | |
| "type": "integer" | |
| }, | |
| "stolen": { | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "uptime": { | |
| "type": "integer" | |
| }, | |
| "load_average": { | |
| "type": "array", | |
| "items": { | |
| "type": "number" | |
| } | |
| }, | |
| "swap": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:os:Swap", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "FsStats": { | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:fs:FsStats", | |
| "properties": { | |
| "filesystems": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:shared:system:stats:fs:FsStats:Filesystem", | |
| "properties": { | |
| "free": { | |
| "type": "integer" | |
| }, | |
| "dev": { | |
| "type": "string" | |
| }, | |
| "total": { | |
| "type": "integer" | |
| }, | |
| "type_name": { | |
| "type": "string" | |
| }, | |
| "used": { | |
| "type": "integer" | |
| }, | |
| "disk_service_time": { | |
| "type": "number" | |
| }, | |
| "inodes_used_percent": { | |
| "type": "integer" | |
| }, | |
| "disk_write_bytes": { | |
| "type": "integer" | |
| }, | |
| "disk_queue": { | |
| "type": "number" | |
| }, | |
| "mount": { | |
| "type": "string" | |
| }, | |
| "sys_type_name": { | |
| "type": "string" | |
| }, | |
| "used_percent": { | |
| "type": "integer" | |
| }, | |
| "inodes_total": { | |
| "type": "integer" | |
| }, | |
| "inodes_free": { | |
| "type": "integer" | |
| }, | |
| "inodes_used": { | |
| "type": "integer" | |
| }, | |
| "disk_reads": { | |
| "type": "integer" | |
| }, | |
| "disk_writes": { | |
| "type": "integer" | |
| }, | |
| "disk_read_bytes": { | |
| "type": "integer" | |
| }, | |
| "available": { | |
| "type": "integer" | |
| }, | |
| "path": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/stats", | |
| "operations": [ | |
| { | |
| "summary": "System information about this node.", | |
| "notes": "This resource returns information about the system this node is running on.", | |
| "method": "GET", | |
| "nickname": "systemStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "SystemStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/stats/fs", | |
| "operations": [ | |
| { | |
| "summary": "Filesystem information about this node.", | |
| "notes": "This resource returns information about the filesystems of this node.", | |
| "method": "GET", | |
| "nickname": "fsStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "FsStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/stats/jvm", | |
| "operations": [ | |
| { | |
| "summary": "JVM information about this node.", | |
| "notes": "This resource returns information about the Java Virtual Machine of this node.", | |
| "method": "GET", | |
| "nickname": "jvmStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "JvmStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/stats/network", | |
| "operations": [ | |
| { | |
| "summary": "Networking information about this node.", | |
| "notes": "This resource returns information about the networking system this node is running with.", | |
| "method": "GET", | |
| "nickname": "networkStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "NetworkStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/stats/os", | |
| "operations": [ | |
| { | |
| "summary": "OS information about this node.", | |
| "notes": "This resource returns information about the operating system this node is running on.", | |
| "method": "GET", | |
| "nickname": "osStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "OsStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/stats/process", | |
| "operations": [ | |
| { | |
| "summary": "Process information about this node.", | |
| "notes": "This resource returns information about the process this node is running as.", | |
| "method": "GET", | |
| "nickname": "processStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ProcessStats", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/system/stats" | |
| } | |
| { | |
| "models": { | |
| "Throughput": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:responses:Throughput", | |
| "properties": { | |
| "throughput": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/throughput", | |
| "operations": [ | |
| { | |
| "summary": "Current throughput of this node in messages per second", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "total", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Throughput", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/system/throughput" | |
| } | |
| { | |
| "models": { | |
| "WhitelistRegexGenerationResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:urlwhitelist:WhitelistRegexGenerationResponse", | |
| "properties": { | |
| "regex": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "UrlWhitelist": { | |
| "id": "urn:jsonschema:org:graylog2:system:urlwhitelist:UrlWhitelist", | |
| "properties": { | |
| "entries": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:system:urlwhitelist:WhitelistEntry", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "literal", | |
| "regex" | |
| ] | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "disabled": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "WhitelistCheckResponse": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:urlwhitelist:WhitelistCheckResponse", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| }, | |
| "is_whitelisted": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "WhitelistRegexGenerationRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:urlwhitelist:WhitelistRegexGenerationRequest", | |
| "properties": { | |
| "url_template": { | |
| "type": "string" | |
| }, | |
| "placeholder": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "WhitelistCheckRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:system:urlwhitelist:WhitelistCheckRequest", | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/system/urlwhitelist", | |
| "operations": [ | |
| { | |
| "summary": "Get url whitelist.", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "UrlWhitelist", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/urlwhitelist", | |
| "operations": [ | |
| { | |
| "summary": "Update url whitelist.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "put", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "whitelist", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "UrlWhitelist" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/urlwhitelist/check", | |
| "operations": [ | |
| { | |
| "summary": "Check if a url is whitelisted.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "check", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "WhitelistCheckResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "WhitelistCheckRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/system/urlwhitelist/generate_regex", | |
| "operations": [ | |
| { | |
| "summary": "Generates a regex that can be used as a value for a whitelist entry.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "generateRegex", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "WhitelistRegexGenerationResponse", | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "WhitelistRegexGenerationRequest" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/system/urlwhitelist" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "UserSummary": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:UserSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "full_name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "grn_permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "preferences": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "session_timeout_ms": { | |
| "type": "integer" | |
| }, | |
| "read_only": { | |
| "type": "boolean" | |
| }, | |
| "external": { | |
| "type": "boolean" | |
| }, | |
| "startpage": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:Startpage", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "session_active": { | |
| "type": "boolean" | |
| }, | |
| "last_activity": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "client_address": { | |
| "type": "string" | |
| }, | |
| "account_status": { | |
| "type": "string", | |
| "enum": [ | |
| "enabled", | |
| "disabled", | |
| "deleted" | |
| ] | |
| } | |
| } | |
| }, | |
| "UpdateUserPreferences": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:UpdateUserPreferences", | |
| "properties": { | |
| "preferences": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| } | |
| }, | |
| "TokenList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:TokenList", | |
| "properties": { | |
| "tokens": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:Token", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| }, | |
| "last_access": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "Token": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:Token", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| }, | |
| "last_access": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "ChangeUserRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:ChangeUserRequest", | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "full_name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "startpage": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:Startpage", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "session_timeout_ms": { | |
| "type": "integer" | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "CreateUserRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:CreateUserRequest", | |
| "properties": { | |
| "username": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "full_name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "session_timeout_ms": { | |
| "type": "integer" | |
| }, | |
| "startpage": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:Startpage", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "UserList": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:UserList", | |
| "properties": { | |
| "users": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:responses:UserSummary", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "username": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "full_name": { | |
| "type": "string" | |
| }, | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "grn_permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "preferences": { | |
| "type": "object", | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| }, | |
| "timezone": { | |
| "type": "string" | |
| }, | |
| "session_timeout_ms": { | |
| "type": "integer" | |
| }, | |
| "read_only": { | |
| "type": "boolean" | |
| }, | |
| "external": { | |
| "type": "boolean" | |
| }, | |
| "startpage": { | |
| "type": "object", | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:Startpage", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "session_active": { | |
| "type": "boolean" | |
| }, | |
| "last_activity": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "client_address": { | |
| "type": "string" | |
| }, | |
| "account_status": { | |
| "type": "string", | |
| "enum": [ | |
| "enabled", | |
| "disabled", | |
| "deleted" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "PermissionEditRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:PermissionEditRequest", | |
| "properties": { | |
| "permissions": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "ChangePasswordRequest": { | |
| "id": "urn:jsonschema:org:graylog2:rest:models:users:requests:ChangePasswordRequest", | |
| "properties": { | |
| "old_password": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/users", | |
| "operations": [ | |
| { | |
| "summary": "List all users", | |
| "notes": "The permissions assigned to the users are always included.", | |
| "method": "GET", | |
| "nickname": "listUsers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "UserList", | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users", | |
| "operations": [ | |
| { | |
| "summary": "Create a new user account.", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "JSON body", | |
| "description": "Must contain username, full_name, email, password and a list of permissions.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "CreateUserRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid user details." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/id/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Removes a user account.", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteUserById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "The id of the user to delete.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "When attempting to remove a read only user (e.g. built-in or LDAP user)." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/id/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Get user details by userId", | |
| "notes": "The user's permissions are only included if a user asks for his own account or for users with the necessary permissions to edit permissions.", | |
| "method": "GET", | |
| "nickname": "getbyId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "UserSummary", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "The userId to return information for.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "The user could not be found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/paginated", | |
| "operations": [ | |
| { | |
| "summary": "Get paginated list of users", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "getPage", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "full_name", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}", | |
| "operations": [ | |
| { | |
| "summary": "Modify user details.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "changeUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "The ID of the user to modify.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "Updated user information.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ChangeUserRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Attempted to modify a read only user account (e.g. built-in or LDAP users)." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid user details." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}/password", | |
| "operations": [ | |
| { | |
| "summary": "Update the password for a user.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "changePassword", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "The id of the user whose password to change.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "The old and new passwords.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ChangePasswordRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 204, | |
| "message": "The password was successfully updated. Subsequent requests must be made with the new password." | |
| }, | |
| { | |
| "code": 400, | |
| "message": "The new password is missing, or the old password is missing or incorrect." | |
| }, | |
| { | |
| "code": 403, | |
| "message": "The requesting user has insufficient privileges to update the password for the given user." | |
| }, | |
| { | |
| "code": 404, | |
| "message": "User does not exist." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}/status/{newStatus}", | |
| "operations": [ | |
| { | |
| "summary": "Update the account status for a user", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "updateAccountStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "The id of the user whose status to change.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "newStatus", | |
| "description": "The account status to be set", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": "enabled", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}/tokens", | |
| "operations": [ | |
| { | |
| "summary": "Retrieves the list of access tokens for a user", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "listTokens", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "TokenList", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}/tokens/{idOrToken}", | |
| "operations": [ | |
| { | |
| "summary": "Removes a token for a user", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "revokeToken", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "idOrToken", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{userId}/tokens/{name}", | |
| "operations": [ | |
| { | |
| "summary": "Generates a new access token for a user", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "generateNewToken", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Token", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "description": "", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "name", | |
| "description": "Descriptive name for this token (e.g. 'cronjob') ", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON Body", | |
| "description": "Placeholder because POST requests should have a body. Set to '{}', the content will be ignored.", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": "{}", | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Removes a user account.", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deleteUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "The name of the user to delete.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "When attempting to remove a read only user (e.g. built-in or LDAP user)." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{username}", | |
| "operations": [ | |
| { | |
| "summary": "Get user details", | |
| "notes": "The user's permissions are only included if a user asks for his own account or for users with the necessary permissions to edit permissions.", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "UserSummary", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "The username to return information for.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 404, | |
| "message": "The user could not be found." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{username}/permissions", | |
| "operations": [ | |
| { | |
| "summary": "Update a user's permission set.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "editPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "The name of the user to modify.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "The list of permissions to assign to the user.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "PermissionEditRequest" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid permission data." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{username}/permissions", | |
| "operations": [ | |
| { | |
| "summary": "Revoke all permissions for a user without deleting the account.", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "deletePermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "The name of the user to modify.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 500, | |
| "message": "When saving the user failed." | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/users/{username}/preferences", | |
| "operations": [ | |
| { | |
| "summary": "Update a user's preferences set.", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "savePreferences", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "description": "The name of the user to modify.", | |
| "required": true, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "JSON body", | |
| "description": "The map of preferences to assign to the user.", | |
| "required": true, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "UpdateUserPreferences" | |
| } | |
| ], | |
| "responseMessages": [ | |
| { | |
| "code": 400, | |
| "message": "Missing or invalid permission data." | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.1:9000/api", | |
| "resourcePath": "/users" | |
| } | |
| { | |
| "models": { | |
| "PaginatedResponse": { | |
| "additional_properties": { | |
| "type": "any" | |
| } | |
| } | |
| }, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/views", | |
| "operations": [ | |
| { | |
| "summary": "Create a new view", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "create", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ViewDTO", | |
| "parameters": [ | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ViewDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views", | |
| "operations": [ | |
| { | |
| "summary": "Get a list of all views", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "views", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "PaginatedResponse", | |
| "parameters": [ | |
| { | |
| "name": "page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "1", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "per_page", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "50", | |
| "type": "Integer" | |
| }, | |
| { | |
| "name": "sort", | |
| "description": "The field to sort the result on", | |
| "required": true, | |
| "paramType": "query", | |
| "defaultValue": "title", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "order", | |
| "description": "The sort direction", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": "asc", | |
| "type": "String" | |
| }, | |
| { | |
| "name": "query", | |
| "description": "", | |
| "required": false, | |
| "paramType": "query", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Get a single view", | |
| "notes": "", | |
| "method": "GET", | |
| "nickname": "get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ViewDTO", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Update view", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "update", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ViewDTO", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| }, | |
| { | |
| "name": "", | |
| "description": "", | |
| "required": false, | |
| "paramType": "body", | |
| "defaultValue": null, | |
| "type": "ViewDTO" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/{id}", | |
| "operations": [ | |
| { | |
| "summary": "Delete view", | |
| "notes": "", | |
| "method": "DELETE", | |
| "nickname": "delete", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "ViewDTO", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| }, | |
| { | |
| "path": "/views/{id}/default", | |
| "operations": [ | |
| { | |
| "summary": "Configures the view as default view", | |
| "notes": "", | |
| "method": "PUT", | |
| "nickname": "setDefault", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "void", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "description": "", | |
| "required": false, | |
| "paramType": "path", | |
| "defaultValue": null, | |
| "type": "String" | |
| } | |
| ], | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.228:9000/api", | |
| "resourcePath": "/views" | |
| } | |
| { | |
| "models": {}, | |
| "apiVersion": "4.0.0+9376305", | |
| "swaggerVersion": "1.2", | |
| "apis": [ | |
| { | |
| "path": "/views/forValue", | |
| "operations": [ | |
| { | |
| "summary": "Get all views that match given parameter value", | |
| "notes": "", | |
| "method": "POST", | |
| "nickname": "forParameter", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "type": "Collection", | |
| "responseMessages": [] | |
| } | |
| ] | |
| } | |
| ], | |
| "basePath": "http://192.168.156.229:9000/api", | |
| "resourcePath": "/views/forValue" | |
| } | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment