How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Viridi Edge Controller API

The edge-controller API from Viridi — 20 operation(s) for edge-controller.

Viridi Edge Controller API is one of 56 APIs that Viridi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include edge-controller. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 22 operations across 20 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 3.7.0.

Requests are made against a single base URL, https://vista.viridiparente.com.

22 operations 20 paths 17 schemas 2 DELETE13 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.7.0
Base URL
https://vista.viridiparente.com
Authentication
HTTP Loginpassword
Resource Areas
1

Authentication & Security 1

Viridi Edge Controller API declares 1 security scheme for authenticating requests. It uses HTTP loginpassword authentication (HTTP_login_form).

  • HTTP_login_form — Enter Username / Password

Paths & Operations 22

Across 20 paths, the API surfaces 22 operations — 2 DELETE, 13 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

edge-controller 22
GET
/api/edges
Get Edges By Ids (getEdgesByIds)
getEdges_1 6 params → 200
POST
/api/edges
Find related edges (findByQuery)
findByQuery_2 body → 200
POST
/api/edge
Create Or Update Edge (saveEdge)
saveEdge body → 200
POST
/api/edge/{edgeId}/{ruleChainId}/root
Set root rule chain for provided edge (setEdgeRootRuleChain)
setEdgeRootRuleChain 2 params → 200
POST
/api/edge/sync/{edgeId}
Sync edge (syncEdge)
syncEdge 1 param → 200
POST
/api/edge/bulk_import
Import the bulk of edges (processEdgesBulkImport)
processEdgesBulkImport body → 200
POST
/api/customer/{customerId}/edge/{edgeId}
Assign edge to customer (assignEdgeToCustomer)
assignEdgeToCustomer 2 params → 200
POST
/api/customer/public/edge/{edgeId}
Make edge publicly available (assignEdgeToPublicCustomer)
assignEdgeToPublicCustomer 1 param → 200
GET
/api/tenant/edges
Get Tenant Edge (getTenantEdge)
getTenantEdges_1 7 params → 200
GET
/api/tenant/edgeInfos
Get Tenant Edge Infos (getTenantEdgeInfos)
getTenantEdgeInfos 6 params → 200
GET
/api/edges/enabled
Is edges support enabled (isEdgesSupportEnabled)
isEdgesSupportEnabled → 200
GET
/api/edge/{edgeId}
Get Edge (getEdgeById)
getEdgeById 1 param → 200
DELETE
/api/edge/{edgeId}
Delete edge (deleteEdge)
deleteEdge 1 param → 200
GET
/api/edge/{edgeId}/upgrade/available
Is edge upgrade enabled (isEdgeUpgradeAvailable)
isEdgeUpgradeAvailable 1 param → 200
GET
/api/edge/types
Get Edge Types (getEdgeTypes)
getEdgeTypes → 200
GET
/api/edge/missingToRelatedRuleChains/{edgeId}
Find missing rule chains (findMissingToRelatedRuleChains)
findMissingToRelatedRuleChains 1 param → 200
GET
/api/edge/instructions/upgrade/{edgeVersion}/{method}
Get Edge Upgrade Instructions (getEdgeUpgradeInstructions)
getEdgeUpgradeInstructions 2 params → 200
GET
/api/edge/instructions/install/{edgeId}/{method}
Get Edge Install Instructions (getEdgeInstallInstructions)
getEdgeInstallInstructions 2 params → 200
GET
/api/edge/info/{edgeId}
Get Edge Info (getEdgeInfoById)
getEdgeInfoById 1 param → 200
GET
/api/customer/{customerId}/edges
Get Customer Edges (getCustomerEdges)
getCustomerEdges 7 params → 200
GET
/api/customer/{customerId}/edgeInfos
Get Customer Edge Infos (getCustomerEdgeInfos)
getCustomerEdgeInfos 7 params → 200
DELETE
/api/customer/edge/{edgeId}
Unassign edge from customer (unassignEdgeFromCustomer)
unassignEdgeFromCustomer 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are EdgeInfo (13 properties), Edge (11 properties), RelationsSearchParameters (6 properties), BulkImportResultEdge (4 properties). Each schema is shown below with its type and property counts.

EdgeInfo
object
13 properties 4 required
Edge
object
A JSON value representing the edge.
11 properties 4 required
Mapping
object
4 properties
ColumnMapping
object
2 properties
RuleChainId
object
2 properties 2 required
EntitySubtype
object
3 properties
PageDataEdge
object
4 properties
JsonNode
A value representing the any type (object or primitive)
PageDataEdgeInfo
object
4 properties
EdgeId
object
2 properties 2 required
BulkImportResultEdge
object
4 properties
BulkImportRequest
object
2 properties
RelationsSearchParameters
object
6 properties
TenantId
object
2 properties 2 required
EdgeInstructions
object
1 property
CustomerId
object
2 properties 2 required
EdgeSearchQuery
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

viridi-parente-edge-controller-api-openapi.yml Raw ↑

Other APIs Viridi publishes across the network.

Viridi Admin Controller API
Viridi Alarm Comment Controller API
Viridi Alarm Controller API
Viridi Asset Controller API
Viridi Asset Profile Controller API
Viridi Audit Log Controller API
Viridi Auth Controller API
Viridi Cbrs Controller API
Viridi Component Descriptor Controller API
Viridi Customer Controller API
Viridi Dashboard Controller API
Viridi Device Connectivity Controller API
Where this information came from

This is an independent, third-party profile of Viridi Edge Controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.