Categorygithub.com/infiotinc/netskopebwan-go-client
repositorypackage
0.0.0-20230825142519-0b6852d430a0
Repository: https://github.com/infiotinc/netskopebwan-go-client.git
Documentation: pkg.go.dev

# README

Go API client for swagger

Introduction Infiot provides API endpoints for interacting with Infiot Management Portal, so that you can rapidly deploy IoT at scale anywhere with automation. Infiot's Developer-friendly SDKs and APIs enable seamless integration.Leverage Infiot SDK and seamlessly integrate with additional services for early time-to-market. The Infiot API is a powerful REST API that can be accessed by an HTTP client tools such as curl/wget, or HTTP libraries of most modern programming languages including Python, GoLang, Java. The API provides abundance of features, listing some of the top rated ones, * Support to interact securely with our API Servers from a Client Web application (API tokens should never be exposed outside). * The API responds with a well-formatted JSON data. * Support for built-in HTTP features, like HTTP authentication and HTTP verbs, which can be easily interpreted by any HTTP clients that are designed to comply with HTTP RFC. If you have good knowledge with REST API, our reference guide will help serve you to get started. To start using Infiot APIs, API tokens need to be created If you have any questions you can reach out to us on [email protected] # Endpoints Our APIs can be accessed through HTTP requests to our API Servers. There are different API servers provisioned based on production stages. The user has to select the applicable API server from the given list of servers populated, and punch in the appropriate MSP tenant name field to get started: https://{tenant}.api.infiot.net All our APIs are [versioned] (#versioning). If there are any changes to the API which either changes the response format or request parameter, the version would be incremented accordingly. # Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the Infiot MSP Portal.The user should have appropriate privileges in the tenant portal for the tokens option to be visible. Tokens can be generated from Tokens navigation window.Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. All API requests must be made over secure HTTP HTTPS. Calls made over plain HTTP or without authentication will fail. Once the token is generated and ready to use, authorize the API token in the swagger hub, click on the Authorize button and in the pop-up, fill the API token and click on Authorize again. # Request Methods Our API endpoints use HTTP request methods to specify the desired operation to be performed. The documentation below specifies request method supported by each endpoint and the resulting action with its appropriate CRUD workflow. | Method Type | CRUD | Description | |- |- |- | | GET | Read | GET requests can be used to retrieve data (eg: get all tenant details from a Master MSP or MSP) | | POST | Create | POST requests can be used to create a new record (eg: adding new tenants to the Master MSP or MSP) | | PUT | Update/Replace | PUT requests can be used for updating an existing record (eg: updating the name or description of a MSP | | DELETE | Delete | DELETE requests can be used to delete a record (like deleting a MSP from the Master MSP) | # Response Codes All API requests will respond with appropriate HTTP status code. Your API client should handle each response class differently. | Response Code | Description | |- |- | | 2XX | These are successful responses and indicate that the API request returned the expected response | | 4XX | These indicate that there was a problem with the request like a missing parameter or invalid values | |5XX | These indicate server errors when the server is unreachable or is misconfigured. In this case, you should retry the API request after some delay | # <a name="versioning">Versioning All our APIs are versioned. Our current API version is v1 and we are continuously working on improving it further and provide additional endpoints. If there are any changes to an API which either changes the response format or request parameter, we will increment the version.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: v9
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/infiot/infiot-api/v2

ClassMethodHTTP requestDescription
DevicePoliciesApiAddDevicePolicyPost /devicepoliciesCreate new Device Policy
DevicePoliciesApiDeleteDevicePolicyByIdDelete /devicepolicies/{id}Delete Device policy using policy Id
DevicePoliciesApiGetAllDevicePoliciesGet /devicepoliciesList all device policies
DevicePoliciesApiGetDevicePolicyByIdGet /devicepolicies/{id}Get device policy using policy Id
DevicePoliciesApiUpdateDevicePolicyByIdPut /devicepolicies/{id}Update device policy details using device policy Id
DevicesApiAddManagedDevicePost /edges/{id}/devicesCreate new managed device
DevicesApiDeleteManagedDeviceByIdDelete /edges/{id}/devices/{deviceId}Delete Managed Device by Id
DevicesApiGetManagedDeviceByIdGet /edges/{id}/devices/{deviceId}Get Managed Device details by Id
DevicesApiGetManagedDeviceListGet /edges/{id}/devicesGet list of managed devices
DevicesApiGetOnlineDeviceListGet /edges/{id}/onlinedevicesGet list of devices that are currently online
DevicesApiUpdateManagedDeviceByIdPut /edges/{id}/devices/{deviceId}Update Managed Device details by Id
EdgesApiActivateEdgeByIdPost /edges/{id}/activateCreate edge activation code
EdgesApiAddEdgePost /edgesCreate a new edge
EdgesApiAddEdgeInterfacePost /edges/{id}/interfacesCreate new interface
EdgesApiDeleteEdgeByIdDelete /edges/{id}Delete Edge by Id value
EdgesApiDeleteEdgeIfByNameDelete /edges/{id}/interfaces/{name}Delete Edge Interface by name
EdgesApiGetAllEdgesGet /edgesList all edges
EdgesApiGetEdgeByIdGet /edges/{id}Get edge by Id value
EdgesApiGetEdgeIfByNameGet /edges/{id}/interfaces/{name}Get edge's interface details by name
EdgesApiGetEdgeInterfaceListGet /edges/{id}/interfacesGet edge's interface list
EdgesApiGetEdgeStatusByIdGet /edges/{id}/statusGet edge last known status by Id value
EdgesApiUpdateEdgeByIdPut /edges/{id}Update edge by Id value
EdgesApiUpdateEdgeIfByNamePut /edges/{id}/interfaces/{name}Update edge interface details by name
MonitoringApiGetGatewayAggregatedDeviceFlowStatsByIDGet /monitoring/gateways/{id}/devices/device_flows_totalsGet gateway device flows aggregated metrics
MonitoringApiGetGatewayAggregatedDeviceStatsByIDGet /monitoring/gateways/{id}/devices/devices_totalsGet gateway devices aggregated metrics
MonitoringApiGetGatewayAggregatedPathAndLinkStatsByIDGet /monitoring/gateways/{id}/wan/paths_links_totalsGet gateway paths and links aggregated metrics
MonitoringApiGetGatewayLTESignalStatsByIDGet /monitoring/gateways/{id}/system/lteGet gateway LTE signal time series statistics
MonitoringApiGetGatewayLatestInterfaceStatsByIDGet /monitoring/gateways/{id}/overview/interfaces_latestGet gateway interfaces latest metrics
MonitoringApiGetGatewayLatestPathStatsByIDGet /monitoring/gateways/{id}/overview/paths_latestGet gateway paths latest metrics
MonitoringApiGetGatewayLatestRouteStatsByIDGet /monitoring/gateways/{id}/overview/routes_latestGet gateway routes latest metrics
MonitoringApiGetGatewayLoadStatsByIDGet /monitoring/gateways/{id}/system/loadGet gateway system load time series statistics
MonitoringApiGetGatewayMemoryStatsByIDGet /monitoring/gateways/{id}/system/memoryGet gateway memory time series statistics
MonitoringApiGetGatewayPathAndLinkStatsByIDGet /monitoring/gateways/{id}/wan/paths_linksGet gateway paths and links time series metrics
MonitoringApiGetGatewayUptimeStatsByIDGet /monitoring/gateways/{id}/system/uptimeGet gateway uptime time series statistics
MonitoringApiGetGatewayWiFiStrengthStatsByIDGet /monitoring/gateways/{id}/system/wifiGet gateway WiFi strength time series statistics
PoliciesApiAddDenySourceIPRuleToPolicyPost /policies/{id}/block-src-ipCreate new firewall block rule for a specific source IP
PoliciesApiAddPolicyPost /policiesCreate new policy
PoliciesApiAddQoSSourceIPRuleToPolicyPost /policies/{id}/qos-rule-src-ipCreate new QoS rule for a specific source IP
PoliciesApiDeleteDenySourceIPRuleFromPolicyDelete /policies/{id}/block-src-ip/{ip}Delete a policy firewall rule using match source IP
PoliciesApiDeletePolicyByIdDelete /policies/{id}Delete policy using policy Id
PoliciesApiDeleteQoSSourceIPRuleFromPolicyDelete /policies/{id}/qos-rule-src-ip/{ip}Delete a policy QoS rule using match source IP
PoliciesApiGetAllPoliciesGet /policiesList all policies
PoliciesApiGetPolicyByIdGet /policies/{id}Get policy using policy Id
PoliciesApiUpdatePolicyByIdPut /policies/{id}Update policy details using policy Id
TenantsApiAddTenantPost /tenantsCreate a new tenant
TenantsApiDeleteTenantByIdDelete /tenants/{tenantId}Delete tenant using tenant Id
TenantsApiGetAllTenantsGet /tenantsList all tenants
TenantsApiGetTenantByIdGet /tenants/{tenantId}Get tenant details using tenant Id
TenantsApiUpdateTenantByIdPut /tenants/{tenantId}Update tenant details using tenant Id
UsersApiAddUserPost /usersCreate a new user
UsersApiDeleteUserByIdDelete /users/{id}Delete User using user Id
UsersApiGetAllUsersGet /usersList all users
UsersApiGetUserByIdGet /users/{id}Get user details using user Id
UsersApiUpdateUserByIdPut /users/{id}Update user details using user Id

Documentation For Models

Documentation For Authorization

AuthToken

Author