Home > Storage > ObjectScale and ECS > Product Documentation > ECS Management REST API: Postman Collection > ECS Management REST API Overview
ECS provides a management REST API to interact with the configuration and reporting of both settings and metrics of the ECS appliance. The API commands cover ECS configuration and capacity monitoring metrics.
Performance Metrics are contained in the InfluxDB as part of the built-in Grafana for ECS Advanced Reporting and are not part of the scope of this document.
The complete ECS Management REST API documentation is available online at the following location:
http://doc.isilon.com/ECS/3.6/API/
https://dl.dell.com/content/docu101271_ecs-3-6-rest-api-reference.zip?language=en_us
The documentation groups the API commands into several high-level categories, as shown in the following figure, on the left-hand side. Some sections have dozens of API commands and some only have a few.
Clicking on any main category shows possible sub-categories into which the API commands are categorized. Selecting a sub-category (green box below) displays the available API commands and the description of what the command covers (blue box below on the right).
Capacity information for Namespaces and Buckets can be found in the Metering section. Selecting the Billing category is where metrics for single, or multiple, Namespaces and Buckets can be retrieved for a given point in time (now) or for a Sample Period with a defined Start and End date and times.
In the example below we see the first command to ‘Get billing details for a specified namespace and bucket name’, right under the command name is the general syntax of the command, shown below.
In the example above you can see that items in single curly brackets { } are strings specific to the ECS environment, such as Namespace and Bucket Name.
The command documentation page is broken into the following sections:
Commands can be run using various methods (such as CURL, HTTP, and so on). To assist customers with an easy way to run and interact with these commands, the ECS Management REST API commands have been packaged into a ‘Collection’. This collection was created in an API utility program called Postman.
The collection of commands has been formatted so that various required inputs in the command syntax (such as ECS Endpoint, Namespace, ECS Management User, Buckets, and so on) are stored as Collection wide variables, displayed in double curly brackets {{variable}}, that can be set and persist through the command set. Not all command parameters are stored as Collection wide variables, some will be manually updated for the specific commands and are shown in single curly brackets: {parameter}.