Jump to Content

API Reference

Common UNITI API Definitions

/connections
- List the available connections.get
- Create a connection.post
/connections/{connectionId}
/endpoints
- List the endpoints.get
- Create an endpoint.post
/endpoints/{endpointId}
/rulesets
- Lists the rulesets.get
- Create a rulesetpost
/rulesets/{rulesetId}
/gel
- Publish an event to the GELpost
/assetTypes
- List asset typesget
- Create an asset typepost
/assetTypes/{assetTypeId}
- Get an asset typeget
- Update an asset typepatch
/assetModels
- List asset modelsget
- Create an asset modelpost
/assetModels/{assetModelId}
- Fetch an asset modelget
- Update an asset modelpatch
/visibleSites
- List the wind sites visible to the userget
/searchTurbines
- Search wind turbines at wind sites visible to the userget
/assets
- List assetsget
- Create an assetpost
/assets:batchCreate
- Batch create assetspost
/assets:uploadCSVFile
- Upload a CSV file containing assetspost
/assets:batchCreateByCSV
- Upload a CSV file containing an asset hierarchypost
/assets/{assetId}
/assets/{assetId}:ancestors
- Get an asset and all of its ancestorsget
/assets/{assetId}:sync
- Sync an asset with an external SAP systempost
/workflows
- List workflowsget
- Create a workflowpost
/workflows/{workflowId}
/missions
- List missionsget
- Create a missionpost
/missions/{missionId}
/missions/{missionId}/tasks
- List a mission's tasksget
- Create a new mission taskpost
/missions:getForTasks
- List distinct missions based on their tasksget
/tasks
- List tasksget
/tasks:countStatus
- Get task status countsget
/tasks/{taskId}
/tasks/{taskId}:markFlown
- Mark a task as flownpost
/tasks/{taskId}/actions
- List actions for a taskget
/tasks/{taskId}/parcels
- List a task's parcelsget
/actionTypes
- List action typesget
- Create an action typepost
/actionTypes/{actionTypeId}
- Get an action typeget
- update an action typepatch
/actions
- Create an actionpost
/actions/{actionId}
/actions/{actionId}/parcels
- List an action's parcelsget
/operator/tasks
- List tasks for the currently authenticated operatorget
/parcels
- List parcelsget
- Create a parcelpost
/parcels:uploaded
- Notify the backend that a file upload has completedpost
/parcels/{parcelId}
/parcels/{parcelId}:uploadUrl
- Obtain a new upload URL for a parcelget
/parcels/{parcelId}:upload
- (Testing only) Upload a parcel to the local filesystemput
/parcels/{parcelId}:downloadUrl
- Obtain a new download URL for a parcel.get
/parcels/{parcelId}:download
- (Testing only) Download a parcel from the local filesystemget
/parcels/{parcelId}:resize
- Download a resized version of an image parcelget
/parcels/{parcelId}/metadata
- Retrieve metadata for a given parcelget
- Update metadata for a given parcelpatch
/status/me
- Get the requesting user's informationget
/status/ping
- Check the current access tokenget
/annotations
- List annotationsget
- Create an annotationpost
/annotations:batchCreate
- Batch create annotationspost
/annotations/{annotationId}
/entries
- List entriesget
- Create an entrypost
/entries:createLinked
- Create a linked entrypost
/entries:batchCreateLinked
- Batch create linked entriespost
/entries:latestMLResults
- Get the latest ML results for assetsget
/entries:annotatedEntries
- Fetch the most recent linked entries with non-ML annotationsget
/entries:publish
- Mark entries as publishedpost
/entries:shareUrl
- Generate a shareable URL for all entries providedget
/entries/{entryId}
/entries/{entryId}:downloadUrl
- Obtain a new download URL for an entryget
/entries/{entryId}/metadata
- Obtain the metadata for a catalog entryget
- Update the metadata for an existing entry.patch
/entries/{entryId}:resize
- Obtain an entry's imageget
/entries/{entryId}:shareUrl
- Generate a shareable URL for an entryget
/entries/{entryId}:share
- Get entry details for a shared URLget
/annotations/{annotationId}/comments
- List annotation commentsget
- Create an annotation commentpost
/annotations/{annotationId}/comments/{commentId}
/annotations/{annotationId}/comments/{commentId}:reply
- Create a reply to an annotation commentpost
/reports
- List reportsget
- Create a report.post
/reports/{reportId}
/reports/{reportId}:clone
- Clone a reportpost
/reports/{reportId}/annotations
- List annotations for a reportget
/reports/{reportId}/annotations/{annotationId}
/devices
- List UNITI devicesget
- Create a new UNITI devicepost
/devices:ping
- Record an aliveness ping from a UNITI devicepost
/devices/{deviceId}
- Get a UNITI deviceget
- Update a UNITI devicepatch
/apps/wind:sitesDamages
- Fetch a list of wind sites/turbines along with their damagesget
/apps/wind:getRecentMLTasks
- Get all recent wind ML tasksget
/apps/linear:distributionFeederStatus
- Fetch the status of one or more feedersget
/_kv
- Set a KV key valuepost
/users/roles
- List rolesget
/users
- List usersget
/users/{userId}
- Get a userget
/users/{userId}:queryPermissions
- Allows querying whether the user has the permissions given in the requestpost
/users/{userId}/assigned_sites
- Gets sites assigned to userget
- Sets sites assigned to userput
/users:discoverServiceAccounts
- Find service accounts in Keycloak and add SpiceDB relationships for thempost

Powered by

Common UNITI API Definitions

/connections
- List the available connections.get
- Create a connection.post
/connections/{connectionId}
/endpoints
- List the endpoints.get
- Create an endpoint.post
/endpoints/{endpointId}
/rulesets
- Lists the rulesets.get
- Create a rulesetpost
/rulesets/{rulesetId}
/gel
- Publish an event to the GELpost
/assetTypes
- List asset typesget
- Create an asset typepost
/assetTypes/{assetTypeId}
- Get an asset typeget
- Update an asset typepatch
/assetModels
- List asset modelsget
- Create an asset modelpost
/assetModels/{assetModelId}
- Fetch an asset modelget
- Update an asset modelpatch
/visibleSites
- List the wind sites visible to the userget
/searchTurbines
- Search wind turbines at wind sites visible to the userget
/assets
- List assetsget
- Create an assetpost
/assets:batchCreate
- Batch create assetspost
/assets:uploadCSVFile
- Upload a CSV file containing assetspost
/assets:batchCreateByCSV
- Upload a CSV file containing an asset hierarchypost
/assets/{assetId}
/assets/{assetId}:ancestors
- Get an asset and all of its ancestorsget
/assets/{assetId}:sync
- Sync an asset with an external SAP systempost
/workflows
- List workflowsget
- Create a workflowpost
/workflows/{workflowId}
/missions
- List missionsget
- Create a missionpost
/missions/{missionId}
/missions/{missionId}/tasks
- List a mission's tasksget
- Create a new mission taskpost
/missions:getForTasks
- List distinct missions based on their tasksget
/tasks
- List tasksget
/tasks:countStatus
- Get task status countsget
/tasks/{taskId}
/tasks/{taskId}:markFlown
- Mark a task as flownpost
/tasks/{taskId}/actions
- List actions for a taskget
/tasks/{taskId}/parcels
- List a task's parcelsget
/actionTypes
- List action typesget
- Create an action typepost
/actionTypes/{actionTypeId}
- Get an action typeget
- update an action typepatch
/actions
- Create an actionpost
/actions/{actionId}
/actions/{actionId}/parcels
- List an action's parcelsget
/operator/tasks
- List tasks for the currently authenticated operatorget
/parcels
- List parcelsget
- Create a parcelpost
/parcels:uploaded
- Notify the backend that a file upload has completedpost
/parcels/{parcelId}
/parcels/{parcelId}:uploadUrl
- Obtain a new upload URL for a parcelget
/parcels/{parcelId}:upload
- (Testing only) Upload a parcel to the local filesystemput
/parcels/{parcelId}:downloadUrl
- Obtain a new download URL for a parcel.get
/parcels/{parcelId}:download
- (Testing only) Download a parcel from the local filesystemget
/parcels/{parcelId}:resize
- Download a resized version of an image parcelget
/parcels/{parcelId}/metadata
- Retrieve metadata for a given parcelget
- Update metadata for a given parcelpatch
/status/me
- Get the requesting user's informationget
/status/ping
- Check the current access tokenget
/annotations
- List annotationsget
- Create an annotationpost
/annotations:batchCreate
- Batch create annotationspost
/annotations/{annotationId}
/entries
- List entriesget
- Create an entrypost
/entries:createLinked
- Create a linked entrypost
/entries:batchCreateLinked
- Batch create linked entriespost
/entries:latestMLResults
- Get the latest ML results for assetsget
/entries:annotatedEntries
- Fetch the most recent linked entries with non-ML annotationsget
/entries:publish
- Mark entries as publishedpost
/entries:shareUrl
- Generate a shareable URL for all entries providedget
/entries/{entryId}
/entries/{entryId}:downloadUrl
- Obtain a new download URL for an entryget
/entries/{entryId}/metadata
- Obtain the metadata for a catalog entryget
- Update the metadata for an existing entry.patch
/entries/{entryId}:resize
- Obtain an entry's imageget
/entries/{entryId}:shareUrl
- Generate a shareable URL for an entryget
/entries/{entryId}:share
- Get entry details for a shared URLget
/annotations/{annotationId}/comments
- List annotation commentsget
- Create an annotation commentpost
/annotations/{annotationId}/comments/{commentId}
/annotations/{annotationId}/comments/{commentId}:reply
- Create a reply to an annotation commentpost
/reports
- List reportsget
- Create a report.post
/reports/{reportId}
/reports/{reportId}:clone
- Clone a reportpost
/reports/{reportId}/annotations
- List annotations for a reportget
/reports/{reportId}/annotations/{annotationId}
/devices
- List UNITI devicesget
- Create a new UNITI devicepost
/devices:ping
- Record an aliveness ping from a UNITI devicepost
/devices/{deviceId}
- Get a UNITI deviceget
- Update a UNITI devicepatch
/apps/wind:sitesDamages
- Fetch a list of wind sites/turbines along with their damagesget
/apps/wind:getRecentMLTasks
- Get all recent wind ML tasksget
/apps/linear:distributionFeederStatus
- Fetch the status of one or more feedersget
/_kv
- Set a KV key valuepost
/users/roles
- List rolesget
/users
- List usersget
/users/{userId}
- Get a userget
/users/{userId}:queryPermissions
- Allows querying whether the user has the permissions given in the requestpost
/users/{userId}/assigned_sites
- Gets sites assigned to userget
- Sets sites assigned to userput
/users:discoverServiceAccounts
- Find service accounts in Keycloak and add SpiceDB relationships for thempost

Powered by

Fetches a target endpoint.

get https://staging.uniti.thread.one/api/endpoints/{endpointId}

Language

Credentials

Bearer

JWT

URL

Click Try It! to start a request and see the response here!