These are the sevices used to list the environments on Apinizer.



1.Get All Environments

Description/Purpose: After successful access to this service, the environments in Apinizer are listed with their status and access addresses.

Permission: The "Admin" user role is required to access the services.

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/environments/

HTTP Method: GET

Request Headers: 

HeaderValue
Authorization

<ACCESS_TOKEN>

Tokens are required to access this endpoint.

For detailed information on how to get tokens, you can visit the Authentication page.

Acceptapplication/json


Request Body: (none)

Response:

StatusStatus CodeDescriptionBody
Success200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
        {
            "name": "Test Environment",
            "type": "TEST",
            "status": "REPUBLISH_REQUIRED",
            "accessUrl": "https://10.10.10.11:30080"
        }
    ],
    "resultCount": 1
}

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

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

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


2.Get all environments reachable from Project

Description/Purpose: Apinizer environments that can be accessed for deploy/undeploy operations through the Project sent as a parameter after successful access are listed.

Permission: The user must have any role in the desired project, to access this service, 

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/environments/{projectName}

HTTP Method: GET

Request Headers: 

HeaderValue
Authorization

<ACCESS_TOKEN>

Tokens are required to access this endpoint.

For detailed information on how to get tokens, you can visit the Authentication page.

Acceptapplication/json


Request Path Parameters:

ParameterValue
projectNameThe full name of the project to be queried


Request Body: (none)

Response:

StatusStatus CodeDescriptionBody
Success200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
        {
            "name": "Test Environment",
            "type": "TEST",
            "status": "REPUBLISH_REQUIRED",
            "accessUrl": "https://10.10.10.11:30080"
        }
    ],
    "resultCount": 1
}

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

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

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