Share via

Workflows - Regenerate Access Key

Service:
App Service
API Version:
2025-05-01

Regenerates the callback URL access key for request triggers.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey?api-version=2025-05-01

URI Parameters

Name In Required Type Description
name
 path True

string

Site name.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
workflowName
 path True

string

The workflow name.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
keyType

KeyType

The key type.

Responses

Name Type Description
200 OK

Azure operation completed successfully.
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Regenerate the callback URL access key for request triggers

Sample request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/testWorkflowName/regenerateAccessKey?api-version=2025-05-01

{
  "keyType": "Primary"
}

Sample response

Status code:
200

Definitions

Name Description
ErrorProperties

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
ErrorResponse

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
KeyType

The key type.
RegenerateActionParameter

The access key regenerate action content.

ErrorProperties

Object

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name Type Description
code

string

Error code.
message

string

Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name Type Description
error

ErrorProperties

The error properties.

KeyType

Enumeration

The key type.

Value Description
NotSpecified
Primary
Secondary

RegenerateActionParameter

Object

The access key regenerate action content.

Name Type Description
keyType

KeyType

The key type.