Get API Proxy Invoke Info

Endpoint

GET /apiops/projects/{projectName}/apiProxies/{apiProxyName}/invoke-info/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
apiProxyName	string	Yes	API Proxy name (must exist)

Query Parameters

None.

Request Body

This endpoint does not require a request body.

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "environmentName": "test",
      "gatewayBaseUrl": "http://127.0.0.1:8091",
      "rootContext": "/apigateway",
      "fullPaths": ["/apigateway/api/v1/pets"],
      "methods": ["GET", "POST"],
      "schemes": ["http"],
      "deployed": true
    },
    {
      "environmentName": "production",
      "gatewayBaseUrl": "https://gateway.example.com",
      "rootContext": "/apigateway",
      "fullPaths": ["/apigateway/api/v1/pets"],
      "methods": ["GET", "POST"],
      "schemes": ["http", "https"],
      "deployed": false
    }
  ],
  "resultCount": 2
}

Response Fields

Field	Type	Description
status	string	Request status (SUCCESS or FAILURE)
resultList	array	One entry per environment defined on the platform (not only environments the proxy is deployed to — check deployed per entry)
resultList[].environmentName	string	Environment name
resultList[].gatewayBaseUrl	string	Public-facing worker/gateway base URL for this environment (the environment's Access URL)
resultList[].rootContext	string	Gateway root context prefix (GeneralSettings.apinizerRootContext), normalized to always have a leading slash and no trailing slash. Shared across all environments
resultList[].fullPaths	array[string]	rootContext + each of the API proxy's clientRoute.relativePathList entries, already joined. Same across all environments (proxy-level, not environment-level)
resultList[].methods	array[string]	Upper-case HTTP methods exposed by the API proxy's endpoints. Same across all environments
resultList[].schemes	array[string]	Schemes accepted by this environment: http (unless explicitly disabled) and/or https (if enabled)
resultList[].deployed	boolean	true if the API proxy is currently deployed to this environment
resultCount	integer	Number of environments returned

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "ApiProxy with name (petstore-api) is not found!"
}

Common Causes

• apiProxyName is empty
• API Proxy name does not exist in the project

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/apiProxies/petstore-api/invoke-info/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Build the invoke URL for a given environment as gatewayBaseUrl + fullPaths[i], for example:

http://127.0.0.1:8091/apigateway/api/v1/pets

Notes and Warnings

• All environments returned: The response always lists every environment defined on the platform, not just the ones the proxy is deployed to — filter on deployed if you only need active environments.
• One hop URL building: This endpoint exists so a CI/CD or E2E caller does not need to separately fetch GeneralSettings.apinizerRootContext, the API proxy's clientRoute.relativePathList, and each environment's Access URL to assemble the final invoke URL.
• Not a liveness check: deployed: true reflects the manager's deploy record, not whether the route is actually loaded on the worker pods right now. Combine with Get Worker Route Health if you need to confirm the route is live before calling it.
• Multiple relative paths: If the API proxy's client route defines more than one relative path, fullPaths contains one entry per path (all sharing the same rootContext).

Permissions

User must have API_MANAGEMENT + VIEW permission in the project.

Related Documentation

• Get Deploy Status - Check whether the proxy is deployed and its last deploy revision
• Get Worker Route Health - Verify the route is actively routable on worker pods
• Get API Proxy - Get full API proxy details
• List Environments - List all environments and their access URLs