These are the services used for saving, deleting, updating and listing API Proxy Groups included in the project.

1. Get All API Proxy Groups for Specified Project

Description/Purpose: It enables the listing of API Proxy Groups in the project with the name provided as a parameter.

Permission: The user seeking access to services must have a role within the project with "Manage Proxy Groups" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/

HTTP Method: GET

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "API Proxy Group Name", "relativePath": "/relative_path", "relativePathEnabled": true, "directAccessToApiProxiesDisabled": true, "applySettingsToApiProxies": true } ], "resultCount": 1 }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

2. Create API Proxy Group

Description/Purpose: It allows the creation of a new API Proxy Group with the specified settings.

See deploy/undeploy endpoint details for API Proxy Group's deploy/undeploy operations.

Permission: The user seeking access to services must have a role within the project with "Manage Proxy Groups" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/

HTTP Method: POST

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json
Content-Type	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on

Request Body:

{
  "name": "api proxy group name",
  "description": "api proxy group description",
  "relativePath": "/relative_path",
  "relativePathEnabled": true,
  "directAccessToApiProxiesDisabled": false,
  "applySettingsToApiProxies": true
}

JS

Field	Description
name	The name value of the API Proxy Group
description	The description value of the API Proxy Group
relativePath	The relative path value of the API Proxy Group
relativePathEnabled	Indicates whether the API Proxy Group can be accessed via the relative path value. It can be accessed via the relativePath value if its value is true.
directAccessToApiProxiesDisabled	Indicates whether direct access can be made to API Proxies within the API Proxy Group. If true, API Proxies cannot be accessed directly.
applySettingsToApiProxies	Indicates whether API Proxy Group settings/policies will be applied when there is direct access to API Proxies within the API Proxy Group. If its value is true, it means these settings will be applied.

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

3.Update API Proxy Group

Description/Purpose: It enables the updating of the API Proxy Group with the name provided as a parameter with the specified settings.

See deploy/undeploy endpoint details for API Proxy Group's deploy/undeploy operations.

Permission: The user seeking access to services must have a role within the project with "Manage Proxy Groups" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/

HTTP Method: UPDATE

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json
Content-Type	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on

Request Body:

{
  "name": "api proxy group name",
  "description": "api proxy group description",
  "relativePath": "/relative_path",
  "relativePathEnabled": true,
  "directAccessToApiProxiesDisabled": false,
  "applySettingsToApiProxies": true
}

JS

Field	Description
name	The name value of the API Proxy Group
description	The description value of the API Proxy Group
relativePath	The relative path value of the API Proxy Group
relativePathEnabled	Indicates whether the API Proxy Group can be accessed via the relative path value. It can be accessed via the relativePath value if its value is true.
directAccessToApiProxiesDisabled	Indicates whether direct access can be made to API Proxies within the API Proxy Group. If true, API Proxies cannot be accessed directly.
applySettingsToApiProxies	Indicates whether API Proxy Group settings/policies will be applied when there is direct access to API Proxies within the API Proxy Group. If its value is true, it means these settings will be applied.

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

4. Delete API Proxy Group

Description/Purpose: It allows the undeployment and deletion of the API Proxy Group with the name provided as a parameter from all environments where it is located.

Permission: The user seeking access to services must have a role within the project with both "Manage Proxy Groups" and "Deploy/Undeploy Proxies" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}

HTTP Method: DELETE

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

5. Add API Proxy to API Proxy Group

Description/Purpose: It allows adding the API Proxy with the name provided as a parameter to the API Proxy Group with the name also provided as a parameter.

Permission: The user seeking access to services must have a role within the project with both "Manage Proxy Groups" and "Manage Proxies" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/apiProxies/{apiProxyName}

HTTP Method: POST

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed
apiProxyName	The full name of the API Proxy to be processed

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

6. Remove API Proxy from API Proxy Group

Description/Purpose: It enables the removal of the API Proxy with the name provided as a parameter from the API Proxy Group with the name also provided as a parameter.

Permission: The user seeking access to services must have a role within the project with both "Manage Proxy Groups" and "Manage Proxies" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/apiProxies/{apiProxyName}

HTTP Method: DELETE

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed
apiProxyName	The full name of the API Proxy to be processed

Request Body: (none)

Response:

Status	Status Code	Description	Body
Succes	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

7. Get All Environments of API Proxy Group

Description/Purpose: It allows listing the status of the API Proxy Group with the name provided as a parameter in the environments.

Permission: The user seeking access to services must have a role within the project with "Manage Proxy Groups" permissions.

Endpoint: https://<management_app_url>/apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments

HTTP Method: GET

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed

Request Body: (none)

Response:

Status	Status Code	Description	Body
Succes	200	successful operation	{ "status": "SUCCESS", "resultList": [ { "name": "Prod Environment", "accessUrl": "https://demo.apinizer.com", "deployed": false, "redeployRequired": false } ], "resultCount": 1 }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

8. Deploy API Proxy Group to the Environment

Description/Purpose: It enables deploying the API Proxy Group with the name provided as a parameter to the specified environment.

Permission: The user seeking access to services must have a role within the project with both "Manage Proxy Groups" and "Deploy/Undeploy Proxies" permissions.

Endpoint: https://apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments/{environmentName}

HTTP Method: POST

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed
environmentName	The name of the processing environment

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }

9. Undeploy API Proxy Group from the Environment

Description/Purpose: Undeploys the API Proxy Group with the name provided as a parameter from the specified environment.

Permission: The user seeking access to services must have a role within the project with both "Manage Proxy Groups" and "Deploy/Undeploy Proxies" permissions.

Endpoint: https:///apiops/projects/{projectName}/apiProxyGroups/{apiProxyGroupName}/environments/{environmentName}

HTTP Method: DELETE

Request Headers:

Header	Value
Authorization	< Access Token > Tokens are required to access this endpoint. For detailed information on how to get tokens, you can visit the Authorization API page.
Accept	application/json

Request Path Parameters:

Parameter	Value
projectName	The full name of the project with the API Proxy Group to act on
apiProxyGroupName	The full name of the API Proxy Group to be processed
environmentName	The name of the processing environment

Request Body: (none)

Response:

Status	Status Code	Description	Body
Success	200	successful operation	{ "status": "SUCCESS" }
Error	400	bad request	{ "error": "...", "error_description": "..." }
Error	401	not authorized for this operation	{ "error": "unauthorized_client", "error_description": "..." }
Error	500	internal error	{ "error": "...", "error_description": "..." }