Update API Proxy Group

Overview

Updates an existing API Proxy Group. The name cannot be changed (it’s used as the identifier). All other fields can be updated.

Endpoint

PUT /apiops/projects/{projectName}/apiProxyGroups/

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header Value Required
Authorization Bearer {token} Yes
Content-Type application/json Yes

Path Parameters

Parameter Type Required Description
projectName string Yes Project name

Request Body

Same structure as Create API Proxy Group. See Create API Proxy Group for field descriptions.

Important Notes

  • name must match the existing API Proxy Group name (cannot be changed)
  • clientRoute can be updated
  • All fields are required (same as create)

Response

Success Response (200 OK)

{
  "success": true
}

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "API Proxy Group (PaymentAPIGroup) is not found or user does not have privilege to access it!"
}

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxyGroups/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "PaymentAPIGroup",
    "description": "Updated Payment API Group",
    "clientRoute": {
      "relativePathList": [
        "/api/v2/payment"
      ],
      "methodList": ["GET", "POST", "PUT", "DELETE"],
      "bufferRequest": true,
      "bufferResponse": true
    }
  }'

Notes and Warnings

  • Name Cannot Change:
    • Name is used as identifier and cannot be changed
    • Use the existing name in the request
  • All Fields Required:
    • All fields must be provided (same as create)
  • Group Must Exist:
    • API Proxy Group with specified name must exist