Skip to content

Latest commit

 

History

History
221 lines (137 loc) · 6.5 KB

DeviceApi.md

File metadata and controls

221 lines (137 loc) · 6.5 KB

\DeviceApi

All URIs are relative to https://api.dotcom-monitor.com/config_api_v1

Method HTTP request Description
AddDevice Put /devices Get device list by platform.
DeleteDevice Delete /device/{device_id} Get Device info.
DisableDeviceAlert Post /device/{device_id}/DisableAlert/ Get Device info.
EditDevice Post /device/{device_id} Edit device list by platform.
GetDevice Get /device/{device_id} Get Device info.
GetDevicesPlataform Get /devices/{platform} Get device list by platform.
GetTasks Get /device/{device_id}/tasks Get Device tasks.

AddDevice

Result AddDevice(ctx, device) Get device list by platform.

Get device list by platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
device Device Device Object

Return type

Result

Authorization

api_key

HTTP request headers

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

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

DeleteDevice

Result DeleteDevice(ctx, deviceId) Get Device info.

Get Device info.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
deviceId string device id

Return type

Result

Authorization

api_key

HTTP request headers

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

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

DisableDeviceAlert

InlineResponse200 DisableDeviceAlert(ctx, deviceId, optional) Get Device info.

Get Device info.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
deviceId string device id
optional *DisableDeviceAlertOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DisableDeviceAlertOpts struct

Name Type Description Notes

alertSilencePeriod | optional.Interface of AlertSilencePeriod| |

Return type

InlineResponse200

Authorization

api_key

HTTP request headers

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

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

EditDevice

Result EditDevice(ctx, deviceId, device) Edit device list by platform.

Edit device list by platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
deviceId string Device id
device Device Device Object

Return type

Result

Authorization

api_key

HTTP request headers

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

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

GetDevice

interface{} GetDevice(ctx, deviceId) Get Device info.

Get Device info.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
deviceId string device id

Return type

interface{}

Authorization

api_key

HTTP request headers

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

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

GetDevicesPlataform

[]int32 GetDevicesPlataform(ctx, platform) Get device list by platform.

Get device list by platform.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
platform string Platform name

Return type

[]int32

Authorization

api_key

HTTP request headers

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

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

GetTasks

[]int32 GetTasks(ctx, deviceId) Get Device tasks.

Get Device tasks.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
deviceId string device id

Return type

[]int32

Authorization

api_key

HTTP request headers

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

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