Ana içeriğe atla

Endpoint

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

Authentication

Requires a Personal API Access Token.
Authorization: Bearer YOUR_TOKEN

Request

Headers

HeaderValueRequired
AuthorizationBearer Yes
Content-Typeapplication/jsonYes

Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject 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
    }
  }'

Permissions

  • User must have API_MANAGEMENT + MANAGE permission in the project

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