Share via

Gateway - Regenerate Key

  • Reference
Service:
API Management
API Version:
2024-05-01

Regenerates specified gateway key invalidating any tokens created with it.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2024-05-01

URI Parameters

Name In Required Type Description
gatewayId
 path True

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
resourceGroupName
 path True

string

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

string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Required Type Description
keyType True

KeyType

The Key being regenerated.

Responses

Name Type Description
204 No Content

Key successfully regenerated
Other Status Codes

ErrorResponse

Error response describing why the operation failed.

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

ApiManagementGatewayRegenerateKey

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gwId/regenerateKey?api-version=2024-05-01

{
  "keyType": "primary"
}

Sample response

Status code:
204

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
GatewayKeyRegenerationRequestContract

Gateway key regeneration request contract properties.
KeyType

The Key being regenerated.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GatewayKeyRegenerationRequestContract

Gateway key regeneration request contract properties.

Name Type Description
keyType

KeyType

The Key being regenerated.

KeyType

The Key being regenerated.

Name Type Description
primary

string

secondary

string