Skip to content

API Endpoints

nexthink_api.Models.NxtEndpoint

Bases: str, Enum

Endpoint list of the Nexthink API.

Enrichment: Final[str] = '/api/v1/enrichment/data/fields' class-attribute instance-attribute

Act: Final[str] = '/api/v1/act/execute' class-attribute instance-attribute

Engage: Final[str] = '/api/v1/euf/campaign/trigger' class-attribute instance-attribute

Workflow: Final[str] = '/api/v1/workflows/execute' class-attribute instance-attribute

WorkflowV2: Final[str] = '/api/v2/workflows/execute' class-attribute instance-attribute

WorkflowThinkletTrigger: Final[str] = '/api/v1/workflows/workflows' class-attribute instance-attribute

WorkflowDetails: Final[str] = '/api/v1/workflows/details' class-attribute instance-attribute

Workflows: Final[str] = '/api/v1/workflows' class-attribute instance-attribute

SparkHandoff: Final[str] = '/api/v1/spark/handoff' class-attribute instance-attribute

DataManagement: Final[str] = '/api/v1/data-management/device/deletions' class-attribute instance-attribute

RemoteActionsDetails: Final[str] = '/api/v1/act/remote-action/details' class-attribute instance-attribute

RemoteActions: Final[str] = '/api/v1/act/remote-action' class-attribute instance-attribute

Nql: Final[str] = '/api/v1/nql/execute' class-attribute instance-attribute

NqlV2: Final[str] = '/api/v2/nql/execute' class-attribute instance-attribute

NqlExport: Final[str] = '/api/v1/nql/export' class-attribute instance-attribute

NqlStatus: Final[str] = '/api/v1/nql/status' class-attribute instance-attribute

Token: Final[str] = '/api/v1/token' class-attribute instance-attribute

get_api_name(path: str) -> Optional[str] classmethod

Get the API name from the path.

Parameters
path : str
    path to the API.
Returns
Optional[str]
    The name of the API or None if path is not in the Endpoints list.