API Reference
The Konnektr Graph API is fully compatible with the Azure Digital Twins Data Plane REST API. You can use existing Azure Digital Twins client libraries and tools with this API.
API Endpoints
Hosted Konnektr Graph
Your hosted graph endpoint: https://your-graph-name.api.graph.konnektr.io
Authentication: Auth0 JWT tokens (see Azure SDK Integration)
Self-Hosted Deployment
Your self-hosted endpoint: https://your-domain.com/api (or custom URL)
Authentication: Configurable (JWT, API keys, or none for development)
Interactive Documentation
Both deployment types provide Swagger UI for interactive API testing:
- Hosted:
https://your-graph-name.api.graph.konnektr.io/swagger - Self-Hosted:
https://your-domain.com/swagger
Digital Twins
Get Digital Twin
- GET /digitaltwins/
{id} - Retrieves a digital twin by its ID.
Create or Replace Digital Twin
- PUT /digitaltwins/
{id} - Creates or replaces a digital twin by its ID.
Update Digital Twin
- PATCH /digitaltwins/
{id} - Updates a digital twin by its ID using a JSON Patch document.
Delete Digital Twin
- DELETE /digitaltwins/
{id} - Deletes a digital twin by its ID.
Relationships
List Relationships
- GET /digitaltwins/
{id}/relationships - Lists all relationships for a digital twin.
Get Relationship
- GET /digitaltwins/
{id}/relationships/{relationshipId} - Retrieves a specific relationship by its ID.
Create or Replace Relationship
- PUT /digitaltwins/
{id}/relationships/{relationshipId} - Creates or replaces a relationship for a digital twin.
Update Relationship
- PATCH /digitaltwins/
{id}/relationships/{relationshipId} - Updates a specific relationship for a digital twin using a JSON Patch document.
Delete Relationship
- DELETE /digitaltwins/
{id}/relationships/{relationshipId} - Deletes a specific relationship for a digital twin.
List Incoming Relationships
- GET /digitaltwins/
{id}/incomingrelationships - Lists all incoming relationships for a digital twin.
Query
Query Digital Twins
- POST /query
- Executes a query against the digital twins graph with pagination support.
Models
List Models
- GET /models
- Lists all models in the digital twins graph.
Create Models
- POST /models
- Creates new models in the digital twins graph.
Delete All Models
- DELETE /models
- Deletes all models in the digital twins graph.
Delete Model
- DELETE /models/
{id} - Deletes a specific model by its ID.
For detailed request/response examples and additional parameters, see the Azure Digital Twins REST API documentation.