Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nexthink Workflows API

The Workflows API from Nexthink — 5 operation(s) for workflows.

Nexthink Workflows API is one of 8 APIs that Nexthink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://{instance}.api.{region}.nexthink.cloud.

5 operations 5 paths 12 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://instance.api.us.nexthink.cloud
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nexthink Workflows API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP bearer tokens (jwt) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows 5
POST
/api/v1/workflows/execute
Trigger a workflow V1
executeEA 2 params body → 200400401403
POST
/api/v2/workflows/execute
Trigger a workflow V2
executeEAWithExternalIds 2 params body → 200400401403
POST
/api/v1/workflows/workflows/{workflowUuid}/execution/{executionUuid}/trigger
Trigger wait for event
triggerThinklet 3 params body → 200400401403
GET
/api/v1/workflows
List workflows
getAllWorkflows 4 params → 200400401403
GET
/api/v1/workflows/details
Get workflow
getWorkflow 2 params → 200400401403

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Workflow (8 properties), ExecutionRequest (4 properties), ExternalIdsExecutionRequest (4 properties), UserData (3 properties). Each schema is shown below with its type and property counts.

ExternalIdsExecutionRequest
object
4 properties 3 required
UserData
object
3 properties
ExecutionResponse
object
Each request spawns one or more executions depending on the input. All executions will have the same request ID and a unique execution ID.
2 properties 2 required
ThinkletTriggerResponse
object
1 property 1 required
ExecutionRequest
object
4 properties 3 required
WorkflowFilter.TriggerMethod
string
ErrorResponse
object
2 properties 2 required
ThinkletTriggerRequest
object
1 property
Workflow.Status
string
DeviceData
object
3 properties
Workflow
object
8 properties 8 required
WorkflowFilter.WorkflowDependency
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexthink-workflows-api-openapi.yml Raw ↑

Other APIs Nexthink publishes across the network.

Nexthink Campaigns API
Nexthink device-deletions API
Nexthink enrichment API
Nexthink Execute API
Nexthink Export API
Nexthink Handoff API API
Nexthink Remote actions API