---
title: "Update Metadata"
method: PATCH
path: "/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/metadata/"
tags: ["ApiProxy"]
---

# Update Metadata

`PATCH /apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/metadata/`

## Request

- Base URL: `http://167.86.118.166:32080`
- URL: `http://167.86.118.166:32080/apiops/projects/{projectName}/apiProxies/{apiProxyName}/settings/metadata/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/apinizer/apis/apinizer-management-apis/docs/apiops/projects/:projectName/apiProxies/:apiProxyName/settings/metadata/patch.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `projectName` string, required
- `apiProxyName` string, required

## Request body

- ApiProxyMetadataUpdateDTO: API Proxy Metadata Update DTO - used to update proxy name, description, categories, and general settings
  - `deploy` boolean: If true, deploy the API Proxy after saving changes
  - `deployTargetEnvironmentNameList` string[]: List of environment names to deploy to (required when deploy=true)
  - `name` string: API Proxy display name (must be unique within the project)
  - `description` string: API Proxy description
  - `categoryList` string[]: 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
  - `disableDirectAccessToGateways` boolean: Disable direct access to gateways (force access through API Portal)
  - `globalApiProxySettingName` string: Global API Proxy Setting name (resolved to ID internally)
  - `backendProxyApplyPolicies` boolean: Apply policies when this proxy acts as a backend proxy
  - `fixSoapApiPortType` boolean: Fix SOAP API port type naming

## Response `200`

successful operation!

- ApiOpsResponseSuccess
  - `status` 'SUCCESS' | 'FAILURE'
  - `resultMessage` string
  - `resultList` string[]
  - `resultCount` integer
  - `deploymentResult` DeploymentResult
    - `envName` string
    - `podName` string
    - `podIp` string
    - `success` boolean
    - `detail` string
    - `responseTime` integer
    - `detailList` unknown[]
      - unknown
    - `firstFromApiResultList` unknown
  - `unresolvedReferences` string[]
  - `advisories` ApiOpsAdvisoryDTO[]
    - `level` string
    - `key` string
    - `params` object

## Other responses

- `401`: not authorized for this operation!
- `500`: internal error!

---

[API](https://skmtc.dev/apinizer/apis/apinizer-management-apis.md) - [All operations](https://skmtc.dev/apinizer/apis/apinizer-management-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/apinizer/apis/apinizer-management-apis/revisions/e083046b24cd?raw)