ApiProxy

Update Metadata

Updates metadata (name, description, category, sharing type) for the specified API Proxy

patch/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/metadata/

Request

projectNamestring required

apiProxyNamestring required

deployboolean

If true, deploy the API Proxy after saving changes

deployTargetEnvironmentNameListstring[]

List of environment names to deploy to (required when deploy=true)

namestring

API Proxy display name (must be unique within the project)

descriptionstring

API Proxy description

categoryListstring[]

List of category names for classification

sharingType'BOTH' | 'NONE' | 'EXTERNAL' | 'INTERNAL'

Sharing type: PUBLIC, PRIVATE, INTERNAL

direction'NONE' | 'PUBLISHER' | 'CONSUMER' | 'BOTH'

API contract direction: REQUEST_RESPONSE, REQUEST_ONLY, RESPONSE_ONLY

disableDirectAccessToGatewaysboolean

Disable direct access to gateways (force access through API Portal)

globalApiProxySettingNamestring

Global API Proxy Setting name (resolved to ID internally)

backendProxyApplyPoliciesboolean

Apply policies when this proxy acts as a backend proxy

fixSoapApiPortTypeboolean

Fix SOAP API port type naming

successful operation!

status'SUCCESS' | 'FAILURE'

resultMessagestring

resultListstring[]

resultCountinteger

unresolvedReferencesstring[]

No recorded changes to this operation across all 21 revisions of this API.