DetectorGroupsApi.md

groundlight_openapi_client.DetectorGroupsApi

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

Method	HTTP request	Description
create_detector_group	POST /v1/detector-groups
get_detector_groups	GET /v1/detector-groups

create_detector_group

DetectorGroup create_detector_group(detector_group_request)

Create a new detector group POST data: Required: - name (str) - name of the predictor set

Example

• Api Key Authentication (ApiToken):

import time
import groundlight_openapi_client
from groundlight_openapi_client.api import detector_groups_api
from groundlight_openapi_client.model.detector_group_request import DetectorGroupRequest
from groundlight_openapi_client.model.detector_group import DetectorGroup
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_groups_api.DetectorGroupsApi(api_client)
    detector_group_request = DetectorGroupRequest(
        name="name_example",
    ) # DetectorGroupRequest | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.create_detector_group(detector_group_request)
        pprint(api_response)
    except groundlight_openapi_client.ApiException as e:
        print("Exception when calling DetectorGroupsApi->create_detector_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
detector_group_request	DetectorGroupRequest

Return type

DetectorGroup

Authorization

ApiToken

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

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

get_detector_groups

[DetectorGroup] get_detector_groups()

List all detector groups

Example

• Api Key Authentication (ApiToken):

import time
import groundlight_openapi_client
from groundlight_openapi_client.api import detector_groups_api
from groundlight_openapi_client.model.detector_group import DetectorGroup
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_groups_api.DetectorGroupsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.get_detector_groups()
        pprint(api_response)
    except groundlight_openapi_client.ApiException as e:
        print("Exception when calling DetectorGroupsApi->get_detector_groups: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[DetectorGroup]

Authorization

ApiToken

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

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