Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /apiops/projects/{projectName}/apiProxyGroups/

​
Authentication

Requires a Personal API Access Token. 
Authorization: Bearer YOUR_TOKEN

​
Request

​
Headers

HeaderValueRequired
AuthorizationBearer Yes

​
Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name

​
Query Parameters

None.

​
Response

​
Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "id": "group-id-1",
      "name": "PaymentAPIGroup",
      "description": "Payment API Group"
    },
    {
      "id": "group-id-2",
      "name": "UserAPIGroup",
      "description": "User Management API Group"
    }
  ],
  "resultCount": 2
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
resultListarray[object]List of API Proxy Groups
resultCountintegerTotal number of API Proxy Groups

​
API Proxy Group Object

FieldTypeDescription
idstringAPI Proxy Group ID
namestringAPI Proxy Group name
descriptionstringAPI Proxy Group description

​
Notes

  • Returns only basic information (id, name, description)
  • Empty list ([]) is returned if no groups exist
  • resultCount is 0 if no groups exist

​
Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​
Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Project(MyProject) was not found or user does not have privilege to access it!"
}

​
cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxyGroups/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Notes and Warnings

  • Basic Information:
    • Returns only basic group information
    • Does not include API Proxy members or detailed settings

​
Permissions

  • User must have any permission in the project (read access)