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

Azure Durable Functions Orchestrations API

Orchestration instance management

Azure Durable Functions Orchestrations API is one of 2 APIs that Azure Durable Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orchestrations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 11 operations across 9 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against 2 base URLs: https://{appName}.azurewebsites.net, http://localhost:7071.

11 operations 9 paths 3 schemas 2 DELETE2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://{appName}.azurewebsites.net
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Azure Durable Functions Orchestrations API declares 1 security scheme for authenticating requests. An API key is passed in the query as code (systemKey). By default, every request must be authenticated.

Paths & Operations 11

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

Orchestrations 11

Orchestration instance management

POST
/runtime/webhooks/durabletask/orchestrators/{functionName}
Start orchestration
startOrchestration 4 params body → 202400
POST
/runtime/webhooks/durabletask/orchestrators/{functionName}/{instanceId}
Start orchestration with explicit instance ID
startOrchestrationWithId 5 params body → 202400
GET
/runtime/webhooks/durabletask/instances
List instances
listInstances 9 params → 200
DELETE
/runtime/webhooks/durabletask/instances
Purge multiple instance histories
purgeInstances 6 params → 200404
GET
/runtime/webhooks/durabletask/instances/{instanceId}
Get instance status
getInstanceStatus 8 params → 200202404
DELETE
/runtime/webhooks/durabletask/instances/{instanceId}
Purge single instance history
purgeInstance 4 params → 200404
POST
/runtime/webhooks/durabletask/instances/{instanceId}/raiseEvent/{eventName}
Raise event
raiseEvent 5 params body → 202400404410
POST
/runtime/webhooks/durabletask/instances/{instanceId}/terminate
Terminate instance
terminateInstance 5 params → 202404410
POST
/runtime/webhooks/durabletask/instances/{instanceId}/suspend
Suspend instance
suspendInstance 5 params → 202404410
POST
/runtime/webhooks/durabletask/instances/{instanceId}/resume
Resume instance
resumeInstance 5 params → 202404410
POST
/runtime/webhooks/durabletask/instances/{instanceId}/rewind
Rewind instance (preview)
rewindInstance 5 params → 202404410

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are StartResponse (8 properties), InstanceStatus (8 properties), PurgeResult (1 property). Each schema is shown below with its type and property counts.

PurgeResult
object
1 property
InstanceStatus
object
8 properties
StartResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

durable-functions-orchestrations-api-openapi.yml Raw ↑

Other APIs Azure Durable Functions publishes across the network.

Azure Durable Functions Entities API
Where this information came from

This is an independent, third-party profile of Azure Durable Functions Orchestrations 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.