DetectorResetApi.md

groundlight_openapi_client.DetectorResetApi

All URIs are relative to https://api.groundlight.ai/device-api

Method	HTTP request	Description
reset_detector	DELETE /v1/detector-reset/{id}

reset_detector

reset_detector(id)

Deletes all image queries on the detector

Example

• Api Key Authentication (ApiToken):

import time
import groundlight_openapi_client
from groundlight_openapi_client.api import detector_reset_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
# See configuration.py for a list of all supported configuration parameters.
configuration = groundlight_openapi_client.Configuration(
    host = "https://api.groundlight.ai/device-api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiToken
configuration.api_key['ApiToken'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiToken'] = 'Bearer'

# Enter a context with an instance of the API client
with groundlight_openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = detector_reset_api.DetectorResetApi(api_client)
    id = "id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_instance.reset_detector(id)
    except groundlight_openapi_client.ApiException as e:
        print("Exception when calling DetectorResetApi->reset_detector: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

ApiToken

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

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