Microsoft Azure Functions Workflows API

The Workflows API from Microsoft Azure Functions — 2 operation(s) for workflows.

Documentation GitHub OpenAPI

Operations 2

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey #

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/appservice/web-apps

📖

GettingStarted

https://learn.microsoft.com/en-us/azure/azure-functions/functions-get-started

📖

APIReference

https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/get

📖

Authentication

https://learn.microsoft.com/en-us/rest/api/azure/#register-your-client-application-with-azure-ad

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-functions/refs/heads/main/openapi/microsoft-azure-functions-workflows-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-functions-workflows-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: WebApps API Client AppServiceEnvironments Workflows API
  version: '2025-05-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Workflows
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey
  : post:
      operationId: Workflows_RegenerateAccessKey
      tags:
      - Workflows
      description: Regenerates the callback URL access key for request triggers.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Site name.
        required: true
        schema:
          type: string
      - name: workflowName
        in: path
        description: The workflow name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Regenerate the callback URL access key for request triggers:
          $ref: ./examples/Workflows_RegenerateAccessKey.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateActionParameter'
        description: The access key type.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate
  : post:
      operationId: Workflows_Validate
      tags:
      - Workflows
      description: Validates the workflow definition.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: name
        in: path
        description: Site name.
        required: true
        schema:
          type: string
      - name: workflowName
        in: path
        description: The workflow name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Validate a workflow:
          $ref: ./examples/Workflows_Validate.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workflow'
        description: The workflow.
        required: true
components:
  schemas:
    FlowAccessControlConfigurationPolicy:
      type: object
      description: The access control configuration policy.
      properties:
        allowedCallerIpAddresses:
          type: array
          description: The allowed caller IP address ranges.
          items:
            $ref: '#/components/schemas/IpAddressRange'
          x-ms-identifiers: []
        openAuthenticationPolicies:
          $ref: '#/components/schemas/OpenAuthenticationAccessPolicies'
          description: The authentication policies for workflow.
    WorkflowProperties:
      type: object
      description: The workflow properties.
      properties:
        provisioningState:
          $ref: '#/components/schemas/WorkflowProvisioningState'
          description: Gets the provisioning state.
          readOnly: true
        createdTime:
          type: string
          format: date-time
          description: Gets the created time.
          readOnly: true
        changedTime:
          type: string
          format: date-time
          description: Gets the changed time.
          readOnly: true
        state:
          $ref: '#/components/schemas/WorkflowState'
          description: The state.
        version:
          type: string
          description: Gets the version.
          readOnly: true
        accessEndpoint:
          type: string
          description: Gets the access endpoint.
          readOnly: true
        endpointsConfiguration:
          $ref: '#/components/schemas/FlowEndpointsConfiguration'
          description: The endpoints configuration.
        accessControl:
          $ref: '#/components/schemas/FlowAccessControlConfiguration'
          description: The access control configuration.
        sku:
          $ref: '#/components/schemas/WorkflowSku'
          description: The sku.
          readOnly: true
        integrationAccount:
          $ref: '#/components/schemas/ResourceReference'
          description: The integration account.
        integrationServiceEnvironment:
          $ref: '#/components/schemas/ResourceReference'
          description: The integration service environment.
        definition:
          description: The definition.
        parameters:
          type: object
          description: The parameters.
          additionalProperties:
            $ref: '#/components/schemas/WorkflowParameter'
        kind:
          $ref: '#/components/schemas/Kind'
          description: The workflow kind.
    WorkflowSkuName:
      type: string
      description: The sku name.
      enum:
      - NotSpecified
      - Free
      - Shared
      - Basic
      - Standard
      - Premium
      x-ms-enum:
        name: WorkflowSkuName
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: Free
          value: Free
        - name: Shared
          value: Shared
        - name: Basic
          value: Basic
        - name: Standard
          value: Standard
        - name: Premium
          value: Premium
    ManagedServiceIdentityType:
      type: string
      description: Type of managed service identity.
      enum:
      - SystemAssigned
      - UserAssigned
      - SystemAssigned, UserAssigned
      - None
      x-ms-enum:
        name: ManagedServiceIdentityType
        modelAsString: false
    ErrorProperties:
      type: object
      description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message indicating why the operation failed.
    FlowAccessControlConfiguration:
      type: object
      description: The access control configuration.
      properties:
        triggers:
          $ref: '#/components/schemas/FlowAccessControlConfigurationPolicy'
          description: The access control configuration for invoking workflow triggers.
        contents:
          $ref: '#/components/schemas/FlowAccessControlConfigurationPolicy'
          description: The access control configuration for accessing workflow run contents.
        actions:
          $ref: '#/components/schemas/FlowAccessControlConfigurationPolicy'
          description: The access control configuration for workflow actions.
        workflowManagement:
          $ref: '#/components/schemas/FlowAccessControlConfigurationPolicy'
          description: The access control configuration for workflow management.
    IpAddress:
      type: object
      description: The ip address.
      properties:
        address:
          type: string
          description: The address.
    ResourceReference:
      type: object
      description: The resource reference.
      properties:
        id:
          type: string
          description: The resource id.
        name:
          type: string
          description: Gets the resource name.
          readOnly: true
        type:
          type: string
          description: Gets the resource type.
          readOnly: true
    KeyType:
      type: string
      description: The key type.
      enum:
      - NotSpecified
      - Primary
      - Secondary
      x-ms-enum:
        name: KeyType
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: Primary
          value: Primary
        - name: Secondary
          value: Secondary
    OpenAuthenticationProviderType:
      type: string
      description: Open authentication policy provider type.
      enum:
      - AAD
      x-ms-enum:
        name: OpenAuthenticationProviderType
        modelAsString: true
        values:
        - name: AAD
          value: AAD
    ErrorResponse:
      type: object
      description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
      properties:
        error:
          $ref: '#/components/schemas/ErrorProperties'
          description: The error properties.
    OpenAuthenticationAccessPolicies:
      type: object
      description: AuthenticationPolicy of type Open.
      properties:
        policies:
          type: object
          description: Open authentication policies.
          additionalProperties:
            $ref: '#/components/schemas/OpenAuthenticationAccessPolicy'
    OpenAuthenticationAccessPolicy:
      type: object
      description: Open authentication access policy defined by user.
      properties:
        type:
          $ref: '#/components/schemas/OpenAuthenticationProviderType'
          description: Type of provider for OAuth.
        claims:
          type: array
          description: The access policy claims.
          items:
            $ref: '#/components/schemas/OpenAuthenticationPolicyClaim'
          x-ms-identifiers:
          - name
    OpenAuthenticationPolicyClaim:
      type: object
      description: Open authentication policy claim.
      properties:
        name:
          type: string
          description: The name of the claim.
        value:
          type: string
          description: The value of the claim.
    FlowEndpointsConfiguration:
      type: object
      description: The endpoints configuration.
      properties:
        workflow:
          $ref: '#/components/schemas/FlowEndpoints'
          description: The workflow endpoints.
        connector:
          $ref: '#/components/schemas/FlowEndpoints'
          description: The connector endpoints.
    WorkflowSku:
      type: object
      description: The sku type.
      properties:
        name:
          $ref: '#/components/schemas/WorkflowSkuName'
          description: The name.
        plan:
          $ref: '#/components/schemas/ResourceReference'
          description: The reference to plan.
      required:
      - name
    WorkflowProvisioningState:
      type: string
      description: The workflow provisioning state.
      enum:
      - NotSpecified
      - Accepted
      - Running
      - Ready
      - Creating
      - Created
      - Deleting
      - Deleted
      - Canceled
      - Failed
      - Succeeded
      - Moving
      - Updating
      - Registering
      - Registered
      - Unregistering
      - Unregistered
      - Completed
      - Renewing
      - Pending
      - Waiting
      - InProgress
      x-ms-enum:
        name: WorkflowProvisioningState
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: Accepted
          value: Accepted
        - name: Running
          value: Running
        - name: Ready
          value: Ready
        - name: Creating
          value: Creating
        - name: Created
          value: Created
        - name: Deleting
          value: Deleting
        - name: Deleted
          value: Deleted
        - name: Canceled
          value: Canceled
        - name: Failed
          value: Failed
        - name: Succeeded
          value: Succeeded
        - name: Moving
          value: Moving
        - name: Updating
          value: Updating
        - name: Registering
          value: Registering
        - name: Registered
          value: Registered
        - name: Unregistering
          value: Unregistering
        - name: Unregistered
          value: Unregistered
        - name: Completed
          value: Completed
        - name: Renewing
          value: Renewing
        - name: Pending
          value: Pending
        - name: Waiting
          value: Waiting
        - name: InProgress
          value: InProgress
    FlowEndpoints:
      type: object
      description: The flow endpoints configuration.
      properties:
        outgoingIpAddresses:
          type: array
          description: The outgoing ip address.
          items:
            $ref: '#/components/schemas/IpAddress'
          x-ms-identifiers:
          - address
        accessEndpointIpAddresses:
          type: array
          description: The access endpoint ip address.
          items:
            $ref: '#/components/schemas/IpAddress'
          x-ms-identifiers:
          - address
    Kind:
      type: string
      description: The workflow kind.
      enum:
      - Stateful
      - Stateless
      x-ms-enum:
        name: Kind
        modelAsString: true
        values:
        - name: Stateful
          value: Stateful
        - name: Stateless
          value: Stateless
    RegenerateActionParameter:
      type: object
      description: The access key regenerate action content.
      properties:
        keyType:
          $ref: '#/components/schemas/KeyType'
          description: The key type.
    WorkflowState:
      type: string
      description: The workflow state.
      enum:
      - NotSpecified
      - Completed
      - Enabled
      - Disabled
      - Deleted
      - Suspended
      x-ms-enum:
        name: WorkflowState
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: Completed
          value: Completed
        - name: Enabled
          value: Enabled
        - name: Disabled
          value: Disabled
        - name: Deleted
          value: Deleted
        - name: Suspended
          value: Suspended
    WorkflowParameter:
      type: object
      description: The workflow parameters.
      properties:
        type:
          $ref: '#/components/schemas/ParameterType'
          description: The type.
        value:
          description: The value.
        metadata:
          description: The metadata.
        description:
          type: string
          description: The description.
    IpAddressRange:
      type: object
      description: The ip address range.
      properties:
        addressRange:
          type: string
          description: The IP address range.
    Workflow:
      type: object
      description: The workflow type.
      properties:
        properties:
          $ref: '#/components/schemas/WorkflowProperties'
          description: The workflow properties.
          x-ms-client-flatten: true
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
          description: Managed service identity.
      allOf:
      - $ref: '#/components/schemas/WorkflowResource'
    UserAssignedIdentity:
      type: object
      description: User Assigned identity.
      properties:
        principalId:
          type: string
          description: Principal Id of user assigned identity
          readOnly: true
        clientId:
          type: string
          description: Client Id of user assigned identity
          readOnly: true
    WorkflowResource:
      type: object
      description: The base resource type.
      properties:
        id:
          type: string
          description: The resource id.
          readOnly: true
        name:
          type: string
          description: Gets the resource name.
          readOnly: true
        type:
          type: string
          description: Gets the resource type.
          readOnly: true
        location:
          type: string
          description: The resource location.
        tags:
          type: object
          description: The resource tags.
          additionalProperties:
            type: string
    ManagedServiceIdentity:
      type: object
      description: Managed service identity.
      properties:
        type:
          $ref: '#/components/schemas/ManagedServiceIdentityType'
          description: Type of managed service identity.
        tenantId:
          type: string
          description: Tenant of managed service identity.
          readOnly: true
        principalId:
          type: string
          description: Principal Id of managed service identity.
          readOnly: true
        userAssignedIdentities:
          type: object
          description: 'The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
          additionalProperties:
            $ref: '#/components/schemas/UserAssignedIdentity'
    ParameterType:
      type: string
      description: The parameter type.
      enum:
      - NotSpecified
      - String
      - SecureString
      - Int
      - Float
      - Bool
      - Array
      - Object
      - SecureObject
      x-ms-enum:
        name: ParameterType
        modelAsString: true
        values:
        - name: NotSpecified
          value: NotSpecified
        - name: String
          value: String
        - name: SecureString
          value: SecureString
        - name: Int
          value: Int
        - name: Float
          value: Float
        - name: Bool
          value: Bool
        - name: Array
          value: Array
        - name: Object
          value: Object
        - name: SecureObject
          value: SecureObject
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.