Api - Update

Service:: API Management

API Version:: 2025-09-01-preview

Updates the specified API of the API Management service instance.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2025-09-01-preview

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	The name of the API Management service.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name	Type	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Describes the revision of the API. If no value is provided, default revision 1 is created
properties.apiRevisionDescription	string maxLength: 256	Description of the API Revision.
properties.apiVersion	string maxLength: 100	Indicates the version identifier of the API if the API is versioned
properties.apiVersionDescription	string maxLength: 256	Description of the API Version.
properties.apiVersionSetId	string	A resource identifier for the related ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Collection of authentication settings included into this API.
properties.contact	ApiContactInformation	Contact information for the API.
properties.description	string	Description of the API. May include HTML formatting tags.
properties.displayName	string minLength: 1 maxLength: 300	API name.
properties.isCurrent	boolean	Indicates if API revision is current api revision.
properties.license	ApiLicenseInformation	License information for the API.
properties.mcpProperties	McpProperties	Properties specific to MCP API type.
properties.path	string minLength: 0 maxLength: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
properties.protocols	Protocol[]	Describes on which protocols the operations in this API can be invoked.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolute URL of the backend service implementing this API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocols over which API is made available.
properties.subscriptionRequired	boolean	Specifies whether an API or Product subscription is required for accessing the API.
properties.termsOfServiceUrl	string	A URL to the Terms of Service for the API. MUST be in the format of a URL.
properties.type	ApiType	Type of API.

Responses

Name	Type	Description
200 OK	ApiContract	The request has succeeded. Headers ETag: string
Other Status Codes	ErrorResponse	An unexpected error response.

Name

Type

Description

200 OK

ApiContract

The request has succeeded.

Headers

ETag: string

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

ApiManagementUpdateApi

Sample request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api?api-version=2025-09-01-preview


{
  "properties": {
    "path": "newecho",
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2"
  }
}

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v4"
)

// Generated from example definition: 2025-09-01-preview/ApiManagementUpdateApi.json
func ExampleAPIClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAPIClient().Update(ctx, "rg1", "apimService1", "echo-api", "*", armapimanagement.APIUpdateContract{
		Properties: &armapimanagement.APIContractUpdateProperties{
			Path:        to.Ptr("newecho"),
			DisplayName: to.Ptr("Echo API New"),
			ServiceURL:  to.Ptr("http://echoapi.cloudapp.net/api2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armapimanagement.APIClientUpdateResponse{
	// 	APIContract: armapimanagement.APIContract{
	// 		Name: to.Ptr("echo-api"),
	// 		Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api"),
	// 		Properties: &armapimanagement.APIContractProperties{
	// 			Path: to.Ptr("newecho"),
	// 			APIRevision: to.Ptr("1"),
	// 			DisplayName: to.Ptr("Echo API New"),
	// 			IsCurrent: to.Ptr(true),
	// 			IsOnline: to.Ptr(true),
	// 			Protocols: []*armapimanagement.Protocol{
	// 				to.Ptr(armapimanagement.ProtocolHTTPS),
	// 			},
	// 			ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api2"),
	// 			SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 				Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 				Query: to.Ptr("subscription-key"),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to updates the specified API of the API Management service instance.
 *
 * @summary updates the specified API of the API Management service instance.
 * x-ms-original-file: 2025-09-01-preview/ApiManagementUpdateApi.json
 */
async function apiManagementUpdateApi() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.api.update("rg1", "apimService1", "echo-api", "*", {
    path: "newecho",
    displayName: "Echo API New",
    serviceUrl: "http://echoapi.cloudapp.net/api2",
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "name": "echo-api",
  "type": "Microsoft.ApiManagement/service/apis",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
  "properties": {
    "path": "newecho",
    "apiRevision": "1",
    "displayName": "Echo API New",
    "isCurrent": true,
    "isOnline": true,
    "protocols": [
      "https"
    ],
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    }
  }
}

Definitions

Name	Description
ApiContactInformation	API contact information
ApiContract	API details.
ApiLicenseInformation	API license information
ApiType	Type of API.
ApiUpdateContract	API update contract details.
ApiVersionSetContractDetails	An API Version Set contains the common configuration for a set of API Versions relating
AuthenticationSettingsContract	API Authentication Settings.
BearerTokenSendingMethods	Form of an authorization grant, which the client uses to request the access token.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
McpEndpoint	Endpoint definition for MCP API type.
McpProperties	Properties specific to MCP API type.
McpTransportType	Transport type for Model Context Protocol API.
OAuth2AuthenticationSettingsContract	API OAuth2 Authentication settings details.
OpenIdAuthenticationSettingsContract	API OAuth2 Authentication settings details.
Protocol
SubscriptionKeyParameterNamesContract	Subscription key parameter names details.
systemData	Metadata pertaining to creation and last modification of the resource.
VersioningScheme	An value that determines where the API Version identifier will be located in a HTTP request.

ApiContactInformation

Object

API contact information

Name	Type	Description
email	string	The email address of the contact person/organization. MUST be in the format of an email address
name	string	The identifying name of the contact person/organization
url	string	The URL pointing to the contact information. MUST be in the format of a URL

ApiContract

Object

API details.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.apiRevision	string minLength: 1 maxLength: 100	Describes the revision of the API. If no value is provided, default revision 1 is created
properties.apiRevisionDescription	string maxLength: 256	Description of the API Revision.
properties.apiVersion	string maxLength: 100	Indicates the version identifier of the API if the API is versioned
properties.apiVersionDescription	string maxLength: 256	Description of the API Version.
properties.apiVersionSet	ApiVersionSetContractDetails	Version set details
properties.apiVersionSetId	string	A resource identifier for the related ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Collection of authentication settings included into this API.
properties.contact	ApiContactInformation	Contact information for the API.
properties.description	string	Description of the API. May include HTML formatting tags.
properties.displayName	string minLength: 1 maxLength: 300	API name. Must be 1 to 300 characters long.
properties.isCurrent	boolean	Indicates if API revision is current api revision.
properties.isOnline	boolean	Indicates if API revision is accessible via the gateway.
properties.license	ApiLicenseInformation	License information for the API.
properties.mcpProperties	McpProperties	Properties specific to MCP API type.
properties.path	string minLength: 0 maxLength: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
properties.protocols	Protocol[]	Describes on which protocols the operations in this API can be invoked.
properties.provisioningState	string	The provisioning state
properties.serviceUrl	string minLength: 0 maxLength: 2000	Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
properties.sourceApiId	string	API identifier of the source API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocols over which API is made available.
properties.subscriptionRequired	boolean	Specifies whether an API or Product subscription is required for accessing the API.
properties.termsOfServiceUrl	string	A URL to the Terms of Service for the API. MUST be in the format of a URL.
properties.type	ApiType	Type of API.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

API license information

Name	Type	Description
name	string	The license name used for the API
url	string	A URL to the license used for the API. MUST be in the format of a URL

ApiType

Enumeration

Type of API.

Value	Description
http
soap
websocket
graphql
odata
grpc
mcp	Model Context Protocol API.

ApiUpdateContract

Object

API update contract details.

Name	Type	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Describes the revision of the API. If no value is provided, default revision 1 is created
properties.apiRevisionDescription	string maxLength: 256	Description of the API Revision.
properties.apiVersion	string maxLength: 100	Indicates the version identifier of the API if the API is versioned
properties.apiVersionDescription	string maxLength: 256	Description of the API Version.
properties.apiVersionSetId	string	A resource identifier for the related ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Collection of authentication settings included into this API.
properties.contact	ApiContactInformation	Contact information for the API.
properties.description	string	Description of the API. May include HTML formatting tags.
properties.displayName	string minLength: 1 maxLength: 300	API name.
properties.isCurrent	boolean	Indicates if API revision is current api revision.
properties.isOnline	boolean	Indicates if API revision is accessible via the gateway.
properties.license	ApiLicenseInformation	License information for the API.
properties.mcpProperties	McpProperties	Properties specific to MCP API type.
properties.path	string minLength: 0 maxLength: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
properties.protocols	Protocol[]	Describes on which protocols the operations in this API can be invoked.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolute URL of the backend service implementing this API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocols over which API is made available.
properties.subscriptionRequired	boolean	Specifies whether an API or Product subscription is required for accessing the API.
properties.termsOfServiceUrl	string	A URL to the Terms of Service for the API. MUST be in the format of a URL.
properties.type	ApiType	Type of API.

ApiVersionSetContractDetails

Object

An API Version Set contains the common configuration for a set of API Versions relating

Name	Type	Description
description	string	Description of API Version Set.
id	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
name	string	The display Name of the API Version Set.
versionHeaderName	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
versionQueryName	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
versioningScheme	VersioningScheme	An value that determines where the API Version identifier will be located in a HTTP request.

AuthenticationSettingsContract

Object

API Authentication Settings.

Name	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Authentication settings
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Collection of OAuth2 authentication settings included into this API.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Authentication Settings
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Collection of Open ID Connect authentication settings included into this API.

BearerTokenSendingMethods

Enumeration

Form of an authorization grant, which the client uses to request the access token.

Value	Description
authorizationHeader	Access token will be transmitted in the Authorization header using Bearer schema
query	Access token will be transmitted as query parameters.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

McpEndpoint

Object

Endpoint definition for MCP API type.

Name	Type	Description
name	string minLength: 1 maxLength: 300	MCP endpoint name, e.g. 'sse' or 'messages'.
uriTemplate	string pattern: ^/.*$	Relative URL path that must start with '/'.

McpProperties

Object

Properties specific to MCP API type.

Name	Type	Description
endpoints	McpEndpoint[]	Collection of MCP endpoint definitions with relative URLs.
transportType	McpTransportType	Transport type for Model Context Protocol API.

McpTransportType

Enumeration

Transport type for Model Context Protocol API.

Value	Description
sse	This API uses HTTP+SSE transport type.
streamable	This API uses the Streamable HTTP transport type.

OAuth2AuthenticationSettingsContract

Object

API OAuth2 Authentication settings details.

Name	Type	Description
authorizationServerId	string	OAuth authorization server identifier.
scope	string	operations scope.

OpenIdAuthenticationSettingsContract

Object

API OAuth2 Authentication settings details.

Name	Type	Description
bearerTokenSendingMethods	BearerTokenSendingMethods[]	How to send token to the server.
openidProviderId	string	OAuth authorization server identifier.

Protocol

Enumeration

Value	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Subscription key parameter names details.

Name	Type	Description
header	string	Subscription key header name.
query	string	Subscription key query string parameter name.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

VersioningScheme

Enumeration

An value that determines where the API Version identifier will be located in a HTTP request.

Value	Description
Segment	The API Version is passed in a path segment.
Query	The API Version is passed in a query parameter.
Header	The API Version is passed in a HTTP header.