{
  "opencollection": "1.0.0",
  "info": {
    "name": "WSO2 API Manager - Admin Advanced Policy (Collection) Advanced Policy (Collection) Platform Gateways API",
    "version": "v4"
  },
  "items": [
    {
      "info": {
        "name": "Platform Gateways",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all platform gateways",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apis.wso2.com/api/am/admin/v4/gateways",
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get all registered platform gateways for the organization.\n"
        },
        {
          "info": {
            "name": "Register a platform gateway",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apis.wso2.com/api/am/admin/v4/gateways",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Register a new platform gateway. A registration token is generated and returned\nonce in the response; store it (e.g. as GATEWAY_CONTROL_PLANE_TOKEN in Docker Compose) for the\ngateway to connect to the control plane WebSocket. The token is stored hashed and cannot be retrieved later.\n"
        },
        {
          "info": {
            "name": "Regenerate registration token for a platform gateway",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apis.wso2.com/api/am/admin/v4/gateways/:gatewayId/regenerate-token",
            "params": [
              {
                "name": "gatewayId",
                "value": "",
                "type": "path",
                "description": "Gateway UUID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Regenerate the registration token for an existing platform gateway. The old token is revoked\nand a new one is generated. Store the new token (e.g. as GATEWAY_CONTROL_PLANE_TOKEN in Docker Compose)\nfor the gateway to reconnect to the control plane WebSocket. The token is returned only once.\n"
        },
        {
          "info": {
            "name": "Update a platform gateway",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://apis.wso2.com/api/am/admin/v4/gateways/:gatewayId",
            "params": [
              {
                "name": "gatewayId",
                "value": "",
                "type": "path",
                "description": "Gateway UUID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update platform gateway metadata. Request body must include all updatable fields (displayName,\ndescription, properties, permissions). Name and vhost cannot be changed. UI should send\nthe full resource representation to align with PUT semantics.\n"
        },
        {
          "info": {
            "name": "Delete a platform gateway",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://apis.wso2.com/api/am/admin/v4/gateways/:gatewayId",
            "params": [
              {
                "name": "gatewayId",
                "value": "",
                "type": "path",
                "description": "Gateway UUID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete a platform gateway and all its references (tokens, instance mappings, revision deployment\nrecords, gateway environment, permissions). Fails with 409 if any API revisions are currently\ndeployed to this gateway; undeploy all APIs from the gateway first.\n"
        }
      ]
    }
  ],
  "bundled": true
}