GET /config/deployment/license_pool

Retrieves the deployed license pool information.

Table 1. GET /config/deployment/license_pool resource details
MIME Type
application/json

Table 2. GET /config/deployment/license_pool request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/deployment/license_pool response codes
HTTP Response Code	Unique Code	Description
200		The license pool was successfully retrieved.
500	1001	An error occurred during the retrieval of the license pool.

Response Description

The deployed license pool information.

eps(allocated) - The amount of EPS rate allocated from the pool.
eps(overallocated) - Whether EPS is overallocated or not in the pool.
eps(total) - The total EPS rate available in the pool.
fpm(allocated) - The amount of FPM rate allocated from the pool.
fpm(overallocated) - Whether FPM is overallocated or not in the pool.
fpm(total) - The total FPM rate available in the pool.

Response Sample


{
    "eps": {
        "allocated": 42,
        "overallocated": true,
        "total": 42
    },
    "fpm": {
        "allocated": 42,
        "overallocated": true,
        "total": 42
    }
}