IHub API Scanners

Create IHub API ScannerCreate IHub API Scanner

A new API scanner can be created using the scanner create API. The details of the API is given below.
URL :- http://<host-name>:<port>/api/smartops/ihub/scanner
Request Type :- POST
Headers:-
Organization-key
Request Body:

{
  "authMethod": "BASIC",
  "channelName": "string",
  "cronScheduler": true,
  "destinations": [
    {
      "apiAuthType": "BASIC",
    "apiHeaders": {},
      "apiPassword": "string",
      "apiRequestMethod": "GET",
      "apiUrl": "string",
      "apiUsername": "string",
    "destinationType": "QUEUE",
      "jsonMappings": {
        "jsonSpecs": [
          {
            "mappings": {},
            "operation": "string"
        }
        ]
      },
      "queueExchangeName": "string",
      "queueHost": "string",
      "queueName": "string",
      "queuePassword": "string",
      "queuePort": 0,
      "queueRoutingKey": "string",
      "queueUsername": "string",
      "queueVhost": "string"
    }
],
  "filterParams": {},
  "headers": {},
  "jsonMappings": {
    "jsonSpecs": [
      {
        "mappings": {},
        "operation": "string"
    }
    ]
  },
  "jsonRequest": "string",
  "password": "string",
  "pollingSchedule": "string",
  "projectId": 0,
  "requestMethod": "GET",
  "url": "string",
  "userName": "string"
}


View all API ScannersView all API Scanners

The configured scanner details for an organization can be viewed using GET API. The details are given below.
URL :- http://<host-name>:<port>/api/smartops/ihub/scanner
Request Method :- GET
Headers:
Organization-key


Update an API ScannerUpdate an API Scanner

The configured scanner details can be edited by using Edit API. The details are given below.
URL :- http://<host-name>:<port> /api/smartops/ihub/scanner
Request Method:- PUT
Headers:-
Organization-key
Request Body:

{
  "active": true,
  "authMethod": "BASIC",
  "channelId": "string",
  "channelName": "string",
  "cronScheduler": true,
  "destinations": [
    {
      "apiAuthType": "BASIC",
      "apiHeaders": {},
      "apiPassword": "string",
      "apiRequestMethod": "GET",
      "apiUrl": "string",
      "apiUsername": "string",
      "destinationType": "QUEUE",
      "jsonMappings": {
        "jsonSpecs": [
          {
          "mappings": {},
            "operation": "string"
          }
        ]
      },
      "queueExchangeName": "string",
      "queueHost": "string",
    "queueName": "string",
      "queuePassword": "string",
      "queuePort": 0,
      "queueRoutingKey": "string",
      "queueUsername": "string",
    "queueVhost": "string"
    }
  ],
  "filterParams": {},
  "headers": {},
  "jsonMappings": {
    "jsonSpecs": [
      {
        "mappings": {},
        "operation": "string"
      }
    ]
  },
  "jsonRequest": "string",
  "orgId": 0,
  "password": "string",
  "pollingSchedule": "string",
  "projectId": 0,
  "requestMethod": "GET",
  "url": "string",
  "userName": "string"
}


Delete an API ScannerDelete an API Scanner

The added scanner can be deleted using the delete API call. The details are given below.
URL :- http://<host-name>:<port> /api/smartops/ihub/scanner
Request Method:- DELETE
Headers:-
Organization-key
Request Body:

{
  "active": true,
  "authMethod": "BASIC",
  "channelId": "string",
  "channelName": "string",
  "cronScheduler": true,
  "destinations": [
    {
      "apiAuthType": "BASIC",
      "apiHeaders": {},
      "apiPassword": "string",
      "apiRequestMethod": "GET",
      "apiUrl": "string",
      "apiUsername": "string",
      "destinationType": "QUEUE",
      "jsonMappings": {
        "jsonSpecs": [
          {
          "mappings": {},
            "operation": "string"
          }
        ]
      },
      "queueExchangeName": "string",
      "queueHost": "string",
    "queueName": "string",
      "queuePassword": "string",
      "queuePort": 0,
      "queueRoutingKey": "string",
      "queueUsername": "string",
    "queueVhost": "string"
    }
  ],
  "filterParams": {},
  "headers": {},
  "jsonMappings": {
    "jsonSpecs": [
      {
        "mappings": {},
        "operation": "string"
      }
    ]
  },
  "jsonRequest": "string",
  "orgId": 0,
  "password": "string",
  "pollingSchedule": "string",
  "projectId": 0,
  "requestMethod": "GET",
  "url": "string",
  "userName": "string"
}



Related Topics:

Feedback

Copyright © 2021 UST Global. All Rights Reserved.