Report APIs are the services used to list the environments on Apinizer.


1.Get All API Proxies

Description/Purpose: After successfully accessing this service, all API Proxies on Apinizer are listed.

Authorization: The user must have an admin role to access this service.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/reports/api-proxies

HTTP Method: GET

Request Headers:

HeaderValue
Authorization

<ACCESS_TOKEN> 

In order to access this endpoint, a token is required.

For detailed information on how to obtain a token, please visit the  Authentication API page.

Acceptapplication/json

Request Param: 

Query ParamValue
includeEndpoints

true or false

Request Body: (none)

Response:

StatusStatus CodeDescriptionBody
Success200

successful operation

{
   "status": "SUCCESS",
   "resultList": [
     {
            "apiName": "API Proxy Name",
            "apiUrlList": [
                "<API_URL>"
            ],
            "apiType": "REST",
            "projectName": "<PROJECT_NAME>",
            "apiSpecUrlList": [
                "<API_SPEC_URL>"
            ],
            "apiRelativePath": "/<PATH>",
            "specFileHidden": false,
            "protocolTransformation": false,
            "apiGroup": false,
            "deployed": true,
            "environmentList": [
                {
                    "environmentName": "<ENV_NAME>",
                    "accessUrl": "<ENV_ACCESS_URL>",
                    "deployed": false,
                    "redeployRequired": false
                },
                {
                    "environmentName": "<ENV_NAME>",
                    "accessUrl": "<ENV_ACCESS_URL>",
                    "deployed": true,
                    "redeployRequired": false
                }
            ],
            "routingConnectionTimeout": 30,
            "routingReadTimeout": 30,
            "authenticationExist": false            
            "rateLimitExist": false,

            "endpointList": [
            {
               "endpoint": "/ep1",
                "description": "Adds two integers. This is a test WebService",
                "active": true,
                "httpMethod": "POST"
            },
            {
                "endpoint": "/ep2",
                "active": true,
                "httpMethod": "POST"
            },
            {
                "endpoint": "/ep3",
                "active": true,
                "httpMethod": "POST"
            },
            {
                "endpoint": "/ep4",
                "active": true,
                "httpMethod": "POST"
            }
        ]

        {
            "apiName": "API Proxy Group Name",
            "apiType": "REST",
            "projectName": "<PROJECT_NAME>",
            "apiRelativePath": "/<PATH>",
            "specFileHidden": false,
            "protocolTransformation": false,
            "apiGroup": true,
            "apiIdListOfApiGroup": [
                "64d23347098d7e1aeb5a4e7b",

             ],
            "deployed": false,
            "environmentList": [
                {
                    "environmentName": "<ENV_NAME>",
                    "accessUrl": "<ENV_ACCESS_URL>",
                    "deployed": true,
                    "redeployRequired": false
                },
                {
                   "environmentName": "<ENV_NAME>",
                    "accessUrl": "<ENV_ACCESS_URL>",
                    "deployed": true,
                    "redeployRequired": false
                }
            ],
            "authenticationExist": false,
            "rateLimitExist": false
        }

 ]

}

Error400bad request{
    "error""...",
    "error_description""..."
}
Error401not authorized for this operation

{
    "error""unauthorized_client",
    "error_description""..."
}

Error500internal error{
    "error""...",
    "error_description""..."
}