Skip to content

Latest commit

 

History

History
255 lines (164 loc) · 8.44 KB

SnifAssistServiceApi.md

File metadata and controls

255 lines (164 loc) · 8.44 KB

.SnifAssistServiceApi

All URIs are relative to http://localhost

Method HTTP request Description
snifAssistServiceGetSnifConfig GET /api/v3/snif/config Summary: Get sniffer configuration parameters Description: Get edge sniffer configuration parameters from GI-mothership.
snifAssistServiceGetSnifPolicy GET /api/v3/snif/policy Summary: Get sniffer policy Description: Get edge sniffer policy from GI-mothership.
snifAssistServicePostSnifFeedback POST /api/v3/snif/feedback Summary: Post sniffer feedback Description: Post policy installation feedback to policy-builder service.
snifAssistServiceTestRegex POST /api/v3/snif/test_regex Summary: Test regex Description: Match a text string with a regular expression using the same sniffer code used in production to match a regex.

snifAssistServiceGetSnifConfig

Snifassistv3GetSnifConfigResponse snifAssistServiceGetSnifConfig()

Example

import { createConfiguration, SnifAssistServiceApi } from '';
import type { SnifAssistServiceApiSnifAssistServiceGetSnifConfigRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SnifAssistServiceApi(configuration);

const request: SnifAssistServiceApiSnifAssistServiceGetSnifConfigRequest = {
    // Provide tenant_id. (optional)
  tenantId: "tenant_id_example",
    // Provide edge_id. (optional)
  edgeId: "edge_id_example",
    // Provide configuration type. (optional)
  configType: "config_type_example",
    // Specify config_id provided by configuration service. (optional)
  configId: "config_id_example",
    // Provide CRC value of configuration parameters that sniffer is currently using. (optional)
  configurationParametersCrc: 1,
};

const data = await apiInstance.snifAssistServiceGetSnifConfig(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
tenantId [string] Provide tenant_id. (optional) defaults to undefined
edgeId [string] Provide edge_id. (optional) defaults to undefined
configType [string] Provide configuration type. (optional) defaults to undefined
configId [string] Specify config_id provided by configuration service. (optional) defaults to undefined
configurationParametersCrc [number] Provide CRC value of configuration parameters that sniffer is currently using. (optional) defaults to undefined

Return type

Snifassistv3GetSnifConfigResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

snifAssistServiceGetSnifPolicy

Snifassistv3StatusResponseBase snifAssistServiceGetSnifPolicy()

Example

import { createConfiguration, SnifAssistServiceApi } from '';
import type { SnifAssistServiceApiSnifAssistServiceGetSnifPolicyRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SnifAssistServiceApi(configuration);

const request: SnifAssistServiceApiSnifAssistServiceGetSnifPolicyRequest = {
    // Specify tenant_id. (optional)
  tenantId: "tenant_id_example",
    // Specify edge_id if known. (optional)
  edgeId: "edge_id_example",
    // Provide CRC value of installed policy that sniffer is currently using. (optional)
  policyCrc: 1,
};

const data = await apiInstance.snifAssistServiceGetSnifPolicy(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
tenantId [string] Specify tenant_id. (optional) defaults to undefined
edgeId [string] Specify edge_id if known. (optional) defaults to undefined
policyCrc [number] Provide CRC value of installed policy that sniffer is currently using. (optional) defaults to undefined

Return type

Snifassistv3StatusResponseBase

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

snifAssistServicePostSnifFeedback

Snifassistv3StatusResponseBase snifAssistServicePostSnifFeedback(snifassistv3PostSnifFeedbackRequest)

Example

import { createConfiguration, SnifAssistServiceApi } from '';
import type { SnifAssistServiceApiSnifAssistServicePostSnifFeedbackRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SnifAssistServiceApi(configuration);

const request: SnifAssistServiceApiSnifAssistServicePostSnifFeedbackRequest = {
  
  snifassistv3PostSnifFeedbackRequest: {
    edgeId: "edgeId_example",
    snifFeedback: {
      batchNum: "batchNum_example",
      message: "message_example",
      status: "SUCCEEDED",
    },
    tenantId: "tenantId_example",
  },
};

const data = await apiInstance.snifAssistServicePostSnifFeedback(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
snifassistv3PostSnifFeedbackRequest Snifassistv3PostSnifFeedbackRequest

Return type

Snifassistv3StatusResponseBase

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

snifAssistServiceTestRegex

Snifassistv3StatusResponseBase snifAssistServiceTestRegex(snifassistv3TestRegexRequest)

Example

import { createConfiguration, SnifAssistServiceApi } from '';
import type { SnifAssistServiceApiSnifAssistServiceTestRegexRequest } from '';

const configuration = createConfiguration();
const apiInstance = new SnifAssistServiceApi(configuration);

const request: SnifAssistServiceApiSnifAssistServiceTestRegexRequest = {
  
  snifassistv3TestRegexRequest: {
    regex: "regex_example",
    tenantId: "tenantId_example",
    text: "text_example",
  },
};

const data = await apiInstance.snifAssistServiceTestRegex(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
snifassistv3TestRegexRequest Snifassistv3TestRegexRequest

Return type

Snifassistv3StatusResponseBase

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]