@itentialopensource/adapter-hyas_protect
Version:
This adapter integrates with system described as: HYAS Protect.
695 lines • 22 kB
JSON
{
"openapi": "3.1.0",
"info": {
"title": "",
"version": "1.0.0"
},
"paths": {
"/aggregates": {
"post": {
"tags": [
"Overview"
],
"operationId": "newcastleProtectTopChartsAggregates",
"description": "The parameters and request body are for method: newcastleProtectTopChartsAggregates. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query_type": {
"type": "string"
},
"top_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"current_doc_count": {
"type": "number"
},
"key": {
"type": "string"
},
"previous_doc_count": {
"type": "number"
}
}
}
}
}
},
"example": {
"query_type": "fqdn",
"top_items": [
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
},
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
}
]
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/bar": {
"post": {
"tags": [
"Overview"
],
"operationId": "newcastleProtectBarChartsBar",
"description": "The parameters and request body are for method: newcastleProtectBarChartsBar. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query_type": {
"type": "string"
},
"top_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"current_doc_count": {
"type": "number"
},
"key": {
"type": "string"
},
"previous_doc_count": {
"type": "number"
},
"previous_key": {
"type": "string"
}
}
}
}
}
},
"example": {
"query_type": "no_answer_queries",
"top_items": [
{
"current_doc_count": 369,
"key": "2021-09-20 00:00:00",
"previous_doc_count": 303,
"previous_key": "2021-09-13 00:00:00"
}
]
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/histogram": {
"post": {
"tags": [
"Overview"
],
"operationId": "newcastleProtectHistogramsHistogram",
"description": "The parameters and request body are for method: newcastleProtectHistogramsHistogram. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query_type": {
"type": "string"
},
"top_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"current_doc_count": {
"type": "number"
},
"key": {
"type": "string"
},
"previous_doc_count": {
"type": "number"
}
}
}
}
}
},
"example": {
"query_type": "queries",
"top_items": [
{
"current_doc_count": 9116,
"key": "debug.opendns.com",
"previous_doc_count": 7151
}
]
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/summary": {
"post": {
"tags": [
"Overview"
],
"operationId": "newcastleProtectSummariesSummary",
"description": "The parameters and request body are for method: newcastleProtectSummariesSummary. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"day_count": {
"type": "number"
},
"query_type": {
"type": "string"
},
"total_count": {
"type": "number"
}
}
},
"example": {
"day_count": 1,
"query_type": "blocked",
"total_count": 5
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/histogram/artifact": {
"post": {
"tags": [
"Logs"
],
"operationId": "newcastleProtectHistogramsHistogramArtifact",
"description": "The parameters and request body are for method: newcastleProtectHistogramsHistogramArtifact. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"days": {
"type": "number"
},
"query_type": {
"type": "string"
}
}
},
"example": {
"days": 7,
"query_type": "string"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/logs": {
"post": {
"tags": [
"Logs"
],
"operationId": "newcastleProtectLogsLogs",
"description": "The parameters and request body are for method: newcastleProtectLogsLogs. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aggregates": {
"type": "object",
"properties": {
"queries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"responses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
}
},
"total_count": {
"type": "number"
}
}
},
"example": {
"aggregates": {
"queries": [
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
},
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
},
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
},
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
},
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
},
{
"count": 2058,
"key": "AAAA",
"name": "AAAA"
}
],
"responses": [
{
"count": 8980,
"key": "NoError",
"name": "NoError"
},
{
"count": 8980,
"key": "NoError",
"name": "NoError"
},
{
"count": 8980,
"key": "NoError",
"name": "NoError"
},
{
"count": 8980,
"key": "NoError",
"name": "NoError"
},
{
"count": 8980,
"key": "NoError",
"name": "NoError"
}
]
},
"total_count": 197
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/passthrough": {
"post": {
"tags": [
"Passthrough"
],
"operationId": "newcastleProtectPassthroughPassthrough",
"description": "The parameters and request body are for method: newcastleProtectPassthroughPassthrough. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"alt_status": {
"type": "string"
},
"artifact": {
"type": "string"
},
"hyas_status": {
"type": "string"
},
"last_seen": {
"type": "string"
},
"query_count": {
"type": "number"
}
}
}
},
"total_count": {
"type": "number"
}
}
},
"example": {
"logs": [
{
"alt_status": "allow",
"artifact": "google.com",
"hyas_status": "blocked",
"last_seen": "2021-11-05T05:00:00",
"query_count": 100
}
],
"total_count": 197
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/report": {
"post": {
"tags": [
"Reports"
],
"operationId": "newcastleProtectReportsGetReport",
"description": "The parameters and request body are for method: newcastleProtectReportsGetReport. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/reports": {
"post": {
"tags": [
"Reports"
],
"operationId": "newcastleProtectReportsGetReports",
"description": "The parameters and request body are for method: newcastleProtectReportsGetReports. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"datetime": {
"type": "string"
},
"datetime_end": {
"type": "string"
},
"datetime_start": {
"type": "string"
},
"report_id": {
"type": "string"
}
}
}
},
"total_count": {
"type": "number"
}
}
},
"example": {
"reports": [
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
},
{
"client_id": "string",
"datetime": "string",
"datetime_end": "string",
"datetime_start": "string",
"report_id": "string"
}
],
"total_count": 4
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
}
},
"components": {
"schemas": {}
}
}