What do I need before I get started?

All API calls are authenticated by the API key (find it in Settings/Account Details tab) and return data on account level in JSON format. If you want to fetch the data for single connection, please add a cloud_connection_id parameter identifying it (find it in Settings/Connections) to your requests.

See our blog post about AP. We've explained how you can get the month to date cost, EC2 cost and the S3 cost

Depending on the type of call, you can get the data from specific time range (UTC), filtered by queries and tags, paginated and sorted. Some of them require custom parameters, like "metric type" or "group by", which are presented in further part of this document.
If you have any questions or comments, contact us at support@cloudvertical.com .

Common parameters

  • Name Description Example Required
    api_key allows us to authenticate your requests &api_key=RuVm7roSnnIYwj7BVLrp Yes
    from defines the beginning of period (UTC) &from=2012-01-01T00:00:00Z Yes
    to defines the end of period (UTC) &to=2012-09-01T10:20:30Z Yes
    format defines format of returning data &format=json Yes
    cloud_connection_id allows you to narrow down the data to a single credential &cloud_connection_id=123 No
    with_tags allows for searching data by specific tag(s) &with_tags[]=tag_name No
    without_tags allows for searching data that not meet specific tag(s) &without_tags[]=tag_name No

Summary

Our API allows you to download almost all of the data about your infrastructure, its cost and utilization. Here are some of the most used and most useful requests.


Toggle parameters Toggle sample requests Toggle sample responses

Month to date cost with cost projection by end of month based on data collected through the API

/v01/usages/overview/cost_summary

Sample Request:
https://resource.cloudvertical.com/v01/usages/overview/cost_summary?api_key=V93xAJGz3QywAbnJucaZ&from=2012-09-01&to=2012-09-27
    Sample Response:
    {
         "cue": {
             "previous": 5.0:1,
             "current": "4.9:1"
         },
         "total_cost": {
             "previous": 1326.16,
             "current": 1281.9399999999998
         },
         "avg_daily_cost": {
             "previous": 47.362857142857145,
             "current": 45.78357142857142
         },
         "end_of_month_estimated_cost": {
             "previous": 1475.69,
             "current": 1373.5071428571428
         },
         "reservations_amortised": {
             "previous": 0,
             "current": 2.5292124337899367
         }
     }

    Back to top

    Month to date cost with cost projection by end of month based on AWS statement data

    /v01/statements/overview/cost_summary

    Sample Request:
    https://resource.cloudvertical.com/v01/statements/overview/cost_summary?api_key=uqisoauiiqo&from=2012-09-01&to=2012-09-27
      Sample Response:
      {
           "cue": {
               "previous":"0.2:1",
               "current": "0.0:1"
           },
           "total_cost": {
               "previous": 1755.6899999999991,
               "current": 2817.2300000000027
           },
           "avg_daily_cost": {
               "previous": 65.02555555555553,
               "current": 104.34185185185196
           },
           "end_of_month_estimated_cost": {
               "previous": 1817.5599999999993,
               "current": 3181.65743545413
           },
           "reservations_amortised": {
               "previous": 0,
               "current": 1.016883666666649
           }
       }

      Back to top

      EC2 cost for certain time frame and tags

      /v01/computes/overview/ec2

      Sample Request:
      https://resource.cloudvertical.com/v01/computes/overview/ec2?api_key=V93xAJGz3QywAbnJucaZ&from=2012-09-01&to=2012-09-27&
        Sample Response:
        {
             "summary": {
               "avg_instances": {
                     "previous": 5.03,
                     "current": 5.74
                 },
                 "avg_ecus": {
                     "previous": 17.92,
                     "current": 20.95
                 },
                 "avg_ram": {
                     "previous": 37.9,
                     "current": 43.05
                 }
             },
             "details": {
                 "total_cost": {
                     "previous": 897.5,
                     "current": 994.27
                 },
                 "ebs_total_cost": {
                     "previous": 114.67,
                     "current": 88.23
                 },
                 "avg_utilisation": {
                     "previous": 23.19,
                     "current": 19.04
                 },
                 "ram_hours_used": {
                     "previous": 22738.14,
                     "current": 25828.81
                 },
                 "ecu_hours_used": {
                     "previous": 10751.31,
                     "current": 12568.2
                 }
             }
         }

        Back to top

        List of EC2 instances costs with unit and timestamp, grouped by specific parameter

        /v01.1/resource_costs/ec2

        Request Parameters:
        Name Description Available Options Required
        metric_type defines type of metric avg Yes
        group defines type of data grouping instance_type, region, platform Yes
        usage_type defines output data type InstanceCost Yes
        interval defines the sampling step day, week, month Yes

        Sample Request:
        https://resource.cloudvertical.com/v01.1/resource_costs/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=InstanceCost&interval=day
          Sample Response:
          [{
               "group_type": "m2.xlarge",
               "time_point": "2012-06-30",
               "unit": "USD",
               "value": "3536.42000000002"
           }]

          Back to top

          List of EBS volumes costs with unit and timestamp, grouped by specific parameter

          /v01.1/resource_costs/ec2

          Request Parameters:
          Name Description Available Options Required
          metric_type defines type of metric avg Yes
          group defines type of data grouping volume_type, region, platform Yes
          usage_type defines output data type EbsCost Yes
          resource defines type of resource EBS Yes
          interval defines the sampling step day, week, month Yes

          Sample Request:
          https://resource.cloudvertical.com/v01.1/resource_costs/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=volume_type&usage_type=EbsCost&interval=day&resource=EBS
            Sample Response:
            [{
                 "group_type": "standard",
                 "time_point": "2012-08-31",
                 "unit": "USD",
                 "value": "232.810000000001"
             }]

            Back to top

            List of RDS instances costs with unit and timestamp, grouped by specific parameter

            /v01.1/resource_costs/rds

            Request Parameters:
            Name Description Available Options Required
            metric_type defines type of metric avg Yes
            group defines type of data grouping instance_type, region, platform Yes
            usage_type defines output data type Cost Yes
            interval defines the sampling step day, week, month Yes

            Sample Request:
            https://resource.cloudvertical.com/v01.1/resource_costs/rds?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=Cost&interval=day
              Sample Response:
              [{
                   "group_type": "db.m2.xlarge",
                   "time_point": "2012-09-05 23:59:59.999999",
                   "unit": "USD",
                   "value": "70.2"
               }]

              Back to top

              List of EC2 instances cost summaries with unit, grouped by specified parameter

              /v01.1/resource_costs/summary/ec2

              Request Parameters:
              Name Description Available Options Required
              metric_type defines type of metric avg Yes
              group defines type of data grouping instance_type, region, lifecycle_type Yes
              resource defines type of resource EC2 Yes

              Sample Request:
              https://resource.cloudvertical.com/v01.1/resource_costs/summary/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=lifecycle_type&resource=EC2
                Sample Response:
                [{
                     "value": "490.425999999999",
                     "group_type": "usage_spot_instance",
                     "unit": "USD"
                 }, {
                     "value": 3457.80800000001,
                     "group_type": "usage_instance",
                     "unit": "USD"
                 }, {
                     "value": 1858.768,
                     "unit": "USD",
                     "group_type": "usage_reserved_instance"
                 }, {
                     "value": 3175.356127853881,
                     "unit": "USD",
                     "group_type": "usage_reserved_instance_with_amortization"
                 }]

                Back to top

                List of EBS volumes cost summaries with unit, grouped by specified parameter

                /v01.1/resource_costs/summary/ec2

                Request Parameters:
                Name Description Available Options Required
                metric_type defines type of metric avg Yes
                group defines type of data grouping volume_type, status, zone Yes
                resource defines type of resource EBS Yes

                Sample Request:
                https://resource.cloudvertical.com/v01.1/resource_costs/summary/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=zone&resource=EBS
                  Sample Response:
                  [{
                       "group_type": "us-east-1a",
                       "unit": "USD",
                       "value": "92.878298611111"
                   }, {
                       "group_type": "eu-west-1a",
                       "unit": "USD",
                       "value": "101.572108333333"
                   }]

                  Back to top

                  List of RDS instances cost summaries with unit, grouped by specified parameter

                  /v01.1/resource_costs/summary/rds

                  Request Parameters:
                  Name Description Available Options Required
                  metric_type defines type of metric avg Yes
                  group defines type of data grouping instance_type, region, lifecycle_type Yes
                  resource defines type of resource RDS Yes

                  Sample Request:
                  https://resource.cloudvertical.com/v01.1/resource_costs/summary/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&resource=RDS
                    Sample Response:
                    [{
                         "group_type": "db.m1.large",
                         "unit": "USD",
                         "value": "2041.68"
                     }, {
                         "group_type": "db.m2.2xlarge",
                         "unit": "USD",
                         "value": "5002.67999999999"
                     }]

                    Back to top

                    List of EC2 instances

                    /v01.1/computes/list/ec2

                    Request Parameters:
                    Name Description Available Options Required
                    page defines specific page number 1..n No
                    per_page defines number of items per page 1..n No
                    query defines main query content word or phrase (searchable fields: label, reference_id, region, instance_type) No
                    sort_by enables sorting by a given column status, reference_id, instance_type, region, cpu_hours, ram_hours, total_cost No
                    order defines order of sorting asc, desc No

                    Sample Request:
                    https://resource.cloudvertical.com/v01.1/computes/list/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10&query=phrase&sort_by=region&order=asc
                      Sample Response:
                      {
                           "current_page": 1,
                           "per_page": 10,
                           "total_entries": 229,
                           "running_entries": 110,
                           "entries": [{
                               "id": "285649",
                               "reference_id": "i-9qmbdk2u",
                               "instance_type": "m1.small",
                               "status": "running",
                               "region": "eu-west-1",
                               "label": null,
                               "total_cost": "5.662",
                               "cpu_hours": "149.810555555556",
                               "ram_hours": "254.677944444444",
                               "utilization": "62.8227190482769"
                           }]
                       }

                      Back to top

                      List of RDS instances

                      /v01.1/computes/list/rds

                      Request Parameters:
                      Name Description Available Options Required
                      page defines specific page number 1..n No
                      per_page defines number of items per page 1..n No
                      query defines main query content word or phrase (searchable fields: label, reference_id, region, instance_type) No
                      sort_by enables sorting by a given column status, reference_id, instance_type, region, cpu_hours, ram_hours, total_cost No
                      order defines order of sorting asc, desc No

                      Sample Request:
                      https://resource.cloudvertical.com/v01.1/computes/list/rds?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-04-20T00:00:00Z&to=2012-06-03T00:00:00Z&cloud_connection_id=&page=0&per_page=30&query=phrase&sort_by=total_cost&order=desc
                        Sample Response:
                        {
                             "current_page": 1,
                             "per_page": 10,
                             "total_entries": 50,
                             "running_entries": 50,
                             "entries": [{
                                 "id": "279913",
                                 "reference_id": "9mftjj5hd6m",
                                 "instance_type": "db.m1.small",
                                 "status": "running",
                                 "region": "us-east-1",
                                 "label": null,
                                 "total_cost": "375.06",
                                 "cpu_hours": "1781.81055555556",
                                 "ram_hours": "3029.07794444445",
                                 "utilization": "39.0512214193926"
                             }]
                         }

                        Back to top

                        List of EMR jobs

                        /v01.1/computes/list/emr

                        Request Parameters:
                        Name Description Available Options Required
                        page defines specific page number 1..n No
                        per_page defines number of items per page 1..n No
                        sort_by enables sorting by a given column status, reference_id No
                        order defines order of sorting asc, desc No

                        Sample Request:
                        https://resource.cloudvertical.com/v01.1/computes/list/emr?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-20T00:00:00Z&to=2012-04-03T00:00:00Z&cloud_connection_id=123&page=1&per_page=20&sort_by=status&order=asc
                          Sample Response:
                          {
                               "current_page": 1,
                               "per_page": 10,
                               "total_entries": 10,
                               "entries": [{
                                   "architecture": "x86_64",
                                   "cloud_connection_id": 659,
                                   "compute_type": "emr",
                                   "cost": null,
                                   "cpu": 0.0,
                                   "created_at": "2012-09-04T00:00:00Z",
                                   "credential_label": null,
                                   "currency": null,
                                   "hypervisor": null,
                                   "id": 280566,
                                   "instance_type": null,
                                   "interval": null,
                                   "label": null,
                                   "launch_time": "2012-09-04T00:00:00Z",
                                   "parent_id": null,
                                   "platform": "linux",
                                   "provider": "Amazon",
                                   "ram": 0.0,
                                   "reference_id": "j-82S0RBH9YOU",
                                   "region": "us-east-1",
                                   "san_storage": null,
                                   "status": "terminated",
                                   "storage": null,
                                   "timestamp": "2012-09-05T23:16:10Z",
                                   "updated_at": "2012-09-05T23:16:10Z",
                                   "user_id": 3008,
                                   "zone": null,
                                   "additional_info": [{
                                       "ec2": {
                                           "architecture": "x86_64",
                                           "cloud_connection_id": 659,
                                           "compute_type": "instance",
                                           "cost": null,
                                           "cpu": 1.0,
                                           "created_at": "2012-09-04T00:00:00Z",
                                           "credential_label": null,
                                           "currency": null,
                                           "hypervisor": "xen",
                                           "id": 280567,
                                           "instance_type": "m1.small",
                                           "interval": null,
                                           "label": null,
                                           "launch_time": "2012-09-04T00:00:00Z",
                                           "parent_id": null,
                                           "platform": "linux",
                                           "provider": "Amazon",
                                           "ram": 1.7,
                                           "reference_id": "i-6cxcwg9g",
                                           "region": "us-east-1",
                                           "san_storage": null,
                                           "status": "terminated",
                                           "storage": null,
                                           "timestamp": "2012-09-05T23:16:10Z",
                                           "updated_at": "2012-09-05T23:16:10Z",
                                           "user_id": 3008,
                                           "zone": "us-east-1a"
                                       },
                                       "start_date": "2012-09-04T00:00:00Z",
                                       "end_date": "2012-09-04T08:00:00Z",
                                       "ec2_cost": 0.64,
                                       "emr_cost": 0.12
                                   }]
                               }]
                           }

                          Back to top

                          List of Cache Clusters

                          /v01.1/computes/list/cache_cluster

                          Request Parameters:
                          Name Description Available Options Required
                          page defines specific page number 1..n No
                          per_page defines number of items per page 1..n No
                          sort_by enables sorting by a given column status, reference_id, instance_type, region No
                          order defines order of sorting asc, desc No

                          Sample Request:
                          https://resource.cloudvertical.com/v01.1/computes/list/cache_cluster?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-03-23T00:00:00Z&to=2012-04-05T00:00:00Z&cloud_connection_id=123&page=1&per_page=10&sort_by=reference_id&order=asc
                            Sample Response:
                            {
                                 "current_page": 1,
                                 "per_page": 10,
                                 "total_entries": 50,
                                 "entries": [{
                                     "architecture": "x86_64",
                                     "cloud_connection_id": 659,
                                     "compute_type": "cache_cluster",
                                     "cost": null,
                                     "cpu": 13.0,
                                     "created_at": "2012-01-01T00:00:00Z",
                                     "credential_label": null,
                                     "currency": null,
                                     "hypervisor": null,
                                     "id": 280209,
                                     "instance_type": "cache.m2.2xlarge",
                                     "interval": null,
                                     "label": null,
                                     "launch_time": "2012-01-01T00:00:00Z",
                                     "parent_id": null,
                                     "platform": "linux",
                                     "provider": "Amazon",
                                     "ram": 33.8,
                                     "reference_id": "i-4djdjnh3",
                                     "region": "eu-west-1",
                                     "san_storage": null,
                                     "status": "running",
                                     "storage": null,
                                     "timestamp": "2012-09-13T06:57:31Z",
                                     "updated_at": "2012-09-13T06:57:31Z",
                                     "user_id": 3008,
                                     "zone": "eu-west-1a",
                                     "additional_info": [{
                                         "architecture": "x86_64",
                                         "cloud_connection_id": 659,
                                         "compute_type": "ec_instance",
                                         "cost": null,
                                         "cpu": 13.0,
                                         "created_at": "2012-01-01T00:00:00Z",
                                         "credential_label": null,
                                         "currency": null,
                                         "hypervisor": null,
                                         "id": 280210,
                                         "instance_type": "cache.m2.2xlarge",
                                         "interval": null,
                                         "label": null,
                                         "launch_time": "2012-01-01T00:00:00Z",
                                         "parent_id": 280209,
                                         "platform": "linux",
                                         "provider": "Amazon",
                                         "ram": 33.8,
                                         "reference_id": "0001",
                                         "region": "eu-west-1",
                                         "san_storage": null,
                                         "status": "running",
                                         "storage": null,
                                         "timestamp": "2012-09-13T06:57:31Z",
                                         "updated_at": "2012-09-13T06:57:31Z",
                                         "user_id": 3008,
                                         "zone": "eu-west-1a",
                                         "total_cost": 352.674,
                                         "avg_usage": 48.2733964619614,
                                         "cue": "2.07:1",
                                         "usage_series": [61.28948264452507, 97.5878870417412, 61.08864259970338, 0.07077479788445418, 49.83350468987482, 72.76878509136601, 54.108162244793036, 50.817653047937114, 81.87472835096997, 96.65546386785184]
                                     }]
                                 }]
                             }

                            Back to top

                            List of Reservations

                            /v01.1/reserved/ec2/list

                            Sample Request:
                            https://resource.cloudvertical.com/v01.1/reserved/ec2/list?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123
                              Sample Response:
                              {
                                   "total_entries": 9,
                                   "entries": [{
                                       "instance_type": "m2.xlarge",
                                       "zone": "eu-west-1a",
                                       "amount": 6.0,
                                       "sum_used_hours": 1872.0,
                                       "sum_on_demand_hours": 0.0,
                                       "usage_cost": 248.976,
                                       "on_demand_cost": 947.232,
                                       "total_hours": 1872.0,
                                       "amortized_cost": 60.54794520547941,
                                       "next_expiring": "2013-06-01T01:00:00+00:00",
                                       "additional_info": [{
                                           "offering_type": "Medium Utilization",
                                           "platform": "Linux/UNIX",
                                           "instance_type": "m2.xlarge",
                                           "start_date": "2012-06-01T01:00:00Z",
                                           "term": "31536000",
                                           "zone": "eu-west-1a",
                                           "purchase_cost": "850",
                                           "amount": 3.0,
                                           "sum_used_hours": "936",
                                           "sum_on_demand_hours": "0",
                                           "usage_cost": "124.488",
                                           "on_demand_cost": 473.616,
                                           "total_hours": 936.0,
                                           "amortized_cost": 30.273972602739704
                                       }]
                                   }]
                               }

                              Back to top

                              EC2 On-demand vs Reserved Hours Used

                              /v01.1/reserved/ec2/metrics

                              Request Parameters:
                              Name Description Available Options Required
                              metric_name defines output data type hours Yes
                              group_type defines type of data grouping instance_type, zone Yes

                              Sample Request:
                              https://resource.cloudvertical.com/v01.1/reserved/ec2/metrics?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&group_type=instance_type&metric_name=hours
                                Sample Response:
                                [{
                                     "group_type": "m1.large",
                                     "ondemand": 0.0,
                                     "reserved": {
                                         "medium": 11712.0
                                     },
                                     "unit": "hours"
                                 }, {
                                     "group_type": "m1.small",
                                     "ondemand": 14662.0,
                                     "reserved": {
                                         "heavy": 8784.0,
                                         "light": 11712.0,
                                         "medium": 20496.0
                                     },
                                     "unit": "hours"
                                 }]

                                Back to top

                                EC2 On-demand vs Reserved Instances Cost

                                /v01.1/reserved/ec2/metrics

                                Request Parameters:
                                Name Description Available Options Required
                                metric_name defines output data type cost Yes
                                group_type defines type of data grouping instance_type, zone Yes

                                Sample Request:
                                https://resource.cloudvertical.com/v01.1/reserved/ec2/metrics?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&group_type=zone&metric_name=cost
                                  Sample Response:
                                  [{
                                       "group_type": "eu-west-1a",
                                       "ondemand": 2430.828,
                                       "reserved": {
                                           "heavy": 2090.591999999878,
                                           "medium": 3673.68799999959,
                                           "light": 1565.143999999947
                                       },
                                       "unit": "USD"
                                   }, {
                                       "group_type": "us-east-1a",
                                       "ondemand": 14558.73,
                                       "reserved": {
                                           "heavy": 1057.007999999941,
                                           "light": 1789.007999999936,
                                           "medium": 3935.231999999968
                                       },
                                       "unit": "USD"
                                   }]

                                  Back to top

                                  Average number of instances

                                  /v01.1/reserved/ec2/metrics

                                  Request Parameters:
                                  Name Description Available Options Required
                                  metric_name defines output data type avg_instances Yes
                                  instance_type defines type of instances i.e. m1.small Yes
                                  group_type defines type of data grouping day, week, month Yes

                                  Sample Request:
                                  https://resource.cloudvertical.com/v01.1/reserved/ec2/metrics?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&group_type=week&metric_name=avg_instances&instance_type=m1.small
                                    Sample Response:
                                    [{
                                         "group_type": "2012-06-03 00:00:00",
                                         "ondemand": 2.142857142857143,
                                         "reserved": {
                                             "heavy": 1.2857142857142858,
                                             "light": 1.7142857142857142,
                                             "medium": 3.0
                                         },
                                         "unit": null
                                     }, {
                                         "group_type": "2012-06-10 00:00:00",
                                         "ondemand": 5.0,
                                         "reserved": {
                                             "heavy": 3.0,
                                             "light": 4.0,
                                             "medium": 7.0
                                         },
                                         "unit": null
                                     }]

                                    Back to top

                                    Average number of instances by life cycle

                                    /v01.1/report/avg_usage_breakdown

                                    Request Parameters:
                                    Name Description Available Options Required
                                    instance_type defines type of instances i.e. m1.small Yes

                                    Sample Request:
                                    https://resource.cloudvertical.com/v01.1/report/avg_usage_breakdown?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&instance_type=m1.small
                                      Sample Response:
                                      {
                                           "reserved_instances": [{
                                               "value": "14",
                                               "time_point": "2012-09-30"
                                           }],
                                           "instances": [{
                                               "value": 0,
                                               "time_point": "2012-09-30"
                                           }],
                                           "spot_instances": [{
                                               "value": "5",
                                               "time_point": "2012-09-30"
                                           }]
                                       }

                                      Back to top

                                      List of Elastic Load Balancers

                                      /v01.1/networks/list/load_balancer

                                      Request Parameters:
                                      Name Description Available Options Required
                                      page defines specific page number 1..n No
                                      per_page defines number of items per page 1..n No
                                      sort_by enables sorting by a given column status, reference_id, region, total_cost No
                                      order defines order of sorting asc, desc No

                                      Sample Request:
                                      https://resource.cloudvertical.com/v01.1/networks/list/load_balancer?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10&sort_by=total_cost&order=asc
                                        Sample Response:
                                        {
                                             "current_page": 1,
                                             "per_page": 10,
                                             "total_entries": 50,
                                             "entries": [{
                                                 "cloud_connection_id": 659,
                                                 "cost": null,
                                                 "created_at": "2012-01-01T00:00:00Z",
                                                 "credential_label": null,
                                                 "currency": null,
                                                 "id": 1901,
                                                 "interval": null,
                                                 "network_type": "load_balancer",
                                                 "provider": "Amazon",
                                                 "reference_id": "eqmc0i8g6i4",
                                                 "region": "us-east-1",
                                                 "status": "running",
                                                 "timestamp": "2012-09-13T06:57:43Z",
                                                 "updated_at": "2012-09-13T06:57:43Z",
                                                 "user_id": 3008,
                                                 "zone": null,
                                                 "total_cost": 8.4
                                             }]
                                         }

                                        Back to top

                                        List of EBS volumes

                                        /v01.1/storage/list/ebs

                                        Request Parameters:
                                        Name Description Available Options Required
                                        page defines specific page number 1..n No
                                        per_page defines number of items per page 1..n No
                                        query defines main query content word or phrase (searchable fields: status, reference_id, zone, volume_type) No
                                        sort_by enables sorting by a given column status, volume_type, reference_id, capacity, zone, total_cost No
                                        order defines order of sorting asc, desc No

                                        Sample Request:
                                        https://resource.cloudvertical.com/v01.1/computes/list/ebs?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10&query=phrase&sort_by=capacity&order=asc
                                          Sample Response:
                                          {
                                               "current_page": 1,
                                               "per_page": 10,
                                               "total_entries": 50,
                                               "entries": [{
                                                   "attached_to_reference_id": "i-x7qoecs4",
                                                   "capacity": 64512.0,
                                                   "iops": null,
                                                   "reference_id": "vol-1k5f918l",
                                                   "status": "in-use",
                                                   "total_cost": "2.51125",
                                                   "volume_type": "standard",
                                                   "zone": "eu-west-1a"
                                               }]
                                           }

                                          Back to top

                                          List of S3 buckets

                                          /v01.1/storage/list/s3_bucket

                                          Request Parameters:
                                          Name Description Available Options Required
                                          page defines specific page number 1..n No
                                          per_page defines number of items per page 1..n No

                                          Sample Request:
                                          https://resource.cloudvertical.com/v01.1/storage/list/s3_bucket?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10
                                            Sample Response:
                                            {
                                                 "current_page": 1,
                                                 "per_page": 10,
                                                 "total_entries": 30,
                                                 "entries": [{
                                                     "attached_to_reference_id": null,
                                                     "capacity": 0.0,
                                                     "cloud_connection_id": 659,
                                                     "compute_id": null,
                                                     "compute_type": null,
                                                     "cost": null,
                                                     "created_at": "2012-01-01T00:00:00Z",
                                                     "credential_label": null,
                                                     "currency": null,
                                                     "id": 1429853,
                                                     "interval": null,
                                                     "label": "915mnt2myyo",
                                                     "parent_id": null,
                                                     "provider": "Amazon",
                                                     "reference_id": "915mnt2myyo",
                                                     "region": "US",
                                                     "status": "running",
                                                     "storage_type": "s3_bucket",
                                                     "timestamp": "2012-09-13T06:59:24Z",
                                                     "updated_at": "2012-09-13T06:59:24Z",
                                                     "user_id": 3008,
                                                     "zone": null,
                                                     "additional_info": [{
                                                         "name": "s3_get_requests",
                                                         "cost": 3.338501,
                                                         "usage": 3674262.0,
                                                         "unit": "Requests"
                                                     }, {
                                                         "name": "s3_put_requests",
                                                         "cost": 30.73084,
                                                         "usage": 3946188.0,
                                                         "unit": "Requests"
                                                     }, {
                                                         "name": "s3_delete_requests",
                                                         "cost": 0.0,
                                                         "usage": 768416.0,
                                                         "unit": "Requests"
                                                     }, {
                                                         "name": "s3_data_transfer_in",
                                                         "cost": 0.0,
                                                         "usage": 2551508.0,
                                                         "unit": "Bytes"
                                                     }, {
                                                         "name": "s3_data_transfer_out",
                                                         "cost": 0.0,
                                                         "usage": 7908243.0,
                                                         "unit": "Bytes"
                                                     }, {
                                                         "name": "s3_standard_storage (object count: 591934)",
                                                         "cost": 0.283138158364789,
                                                         "usage": 1775464547814.07,
                                                         "unit": "ByteHrs"
                                                     }]
                                                 }]
                                             }

                                            Back to top

                                            List of S3 buckets costs

                                            /v01.1/storage/list/s3_bucket

                                            Request Parameters:
                                            Name Description Available Options Required
                                            page defines specific page number 1..n No
                                            per_page defines number of items per page 1..n No
                                            forecast gets additional costs data (standard storage, reduced redundancy storage and total costs) in response true Yes

                                            Sample Request:
                                            https://resource.cloudvertical.com/v01.1/storage/list/s3_bucket?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10&forecast=true
                                              Sample Response:
                                              {
                                                   "current_page": 2,
                                                   "per_page": 1,
                                                   "total_entries": 30,
                                                   "entries": [{
                                                       "attached_to_reference_id": null,
                                                       "capacity": 0.0,
                                                       "cloud_connection_id": 659,
                                                       "compute_id": null,
                                                       "compute_type": null,
                                                       "cost": null,
                                                       "created_at": "2012-01-01T00:00:00Z",
                                                       "credential_label": null,
                                                       "currency": null,
                                                       "id": 1429853,
                                                       "interval": null,
                                                       "label": "915mnt2myyo",
                                                       "parent_id": null,
                                                       "provider": "Amazon",
                                                       "reference_id": "915mnt2myyo",
                                                       "region": "US",
                                                       "status": "running",
                                                       "storage_type": "s3_bucket",
                                                       "timestamp": "2012-09-13T06:59:24Z",
                                                       "updated_at": "2012-09-13T06:59:24Z",
                                                       "user_id": 3008,
                                                       "zone": null,
                                                       "standard_cost": 0.283138158364789,
                                                       "standard_forecast": 0.65339575007259,
                                                       "standard_last_month_cost": 6.04577756346847,
                                                       "reduced_cost": 0.164455260287707,
                                                       "reduced_forecast": 0.37951213912547765,
                                                       "reduced_last_month_cost": 4.58817894316191,
                                                       "total_cost": 34.516934418652504,
                                                       "total_forecast": 79.65446404304424,
                                                       "total_last_month_cost": 1338.3116205066303
                                                   }]
                                               }

                                              Back to top

                                              List of Dynamo DBs

                                              /v01.1/storage/list/dynamo_db

                                              Request Parameters:
                                              Name Description Available Options Required
                                              page defines specific page number 1..n No
                                              per_page defines number of items per page 1..n No
                                              sort_by enables sorting by a given column status, reference_id No
                                              order defines order of sorting asc, desc No

                                              Sample Request:
                                              https://resource.cloudvertical.com/v01.1/storage/list/dynamo_db?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&page=0&per_page=10&sort_by=status&order=asc
                                                Sample Response:
                                                {
                                                     "current_page": 1,
                                                     "per_page": 10,
                                                     "total_entries": 50,
                                                     "entries": [{
                                                         "attached_to_reference_id": null,
                                                         "capacity": 0.0,
                                                         "cloud_connection_id": 659,
                                                         "compute_id": null,
                                                         "compute_type": null,
                                                         "cost": null,
                                                         "created_at": "2012-01-01T00:00:00Z",
                                                         "credential_label": null,
                                                         "currency": null,
                                                         "id": 1429082,
                                                         "interval": null,
                                                         "label": "c4ws9re517c",
                                                         "parent_id": null,
                                                         "provider": "Amazon",
                                                         "reference_id": "c4ws9re517c",
                                                         "region": "eu-west-1",
                                                         "status": "running",
                                                         "storage_type": "dynamo_db",
                                                         "timestamp": "2012-09-13T06:59:24Z",
                                                         "updated_at": "2012-09-13T06:59:24Z",
                                                         "user_id": 3008,
                                                         "zone": null,
                                                         "additional_info": [{
                                                             "name": "write_capacity_units",
                                                             "cost": 26.84767,
                                                             "usage": 1012.0,
                                                             "unit": "Units"
                                                         }, {
                                                             "name": "read_capacity_units",
                                                             "cost": 3.268412,
                                                             "usage": 616.0,
                                                             "unit": "Units"
                                                         }]
                                                     }]
                                                 }

                                                Back to top

                                                List of EC2 usages

                                                /v01.1/usages/stats/ec2

                                                Request Parameters:
                                                Name Description Available Options Required
                                                metric_type defines type of metric avg Yes
                                                group defines type of data grouping instance_type, region, platform Yes
                                                usage_type defines output data type CPUUtilization, NetworkIn, NetworkOut Yes
                                                interval defines the sampling step day, week, month Yes

                                                Sample Request:
                                                https://resource.cloudvertical.com/v01.1/usages/stats/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=CPUUtilization&interval=day
                                                  Sample Response:
                                                  CPUUtilization:
                                                   [{
                                                       "time_point": "2012-09-01 23:59:59.999999",
                                                       "value": "13.9049517933123",
                                                       "group_type": "m1.xlarge",
                                                       "unit": "Percent"
                                                   }]
                                                  
                                                   NetworkIn:
                                                   [{
                                                       "time_point": "2012-09-01 23:59:59.999999",
                                                       "value": "618",
                                                       "group_type": "m1.small",
                                                       "unit": "Bytes"
                                                   }]
                                                   
                                                   NetworkOut:
                                                   [{
                                                       "time_point": "2012-09-02 23:59:59.999999",
                                                       "value": "399",
                                                       "group_type": "m2.xlarge",
                                                       "unit": "Bytes"
                                                   }]

                                                  Back to top

                                                  List of RDS usages

                                                  /v01.1/usages/stats/rds

                                                  Request Parameters:
                                                  Name Description Available Options Required
                                                  metric_type defines type of metric avg Yes
                                                  group defines type of data grouping instance_type, region, platform Yes
                                                  usage_type defines output data type FreeableMemory, ReadIOPS, WriteIOPS Yes
                                                  interval defines the sampling step day, week, month Yes

                                                  Sample Request:
                                                  https://resource.cloudvertical.com/v01.1/usages/stats/rds?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=FreeableMemory&interval=day
                                                    Sample Response:
                                                    FreeableMemory:
                                                     [{
                                                         "time_point": "2012-09-01 23:59:59.999999",
                                                         "value": "39.2423218039355",
                                                         "group_type": "db.m1.large",
                                                         "unit": "Bytes"
                                                     }]
                                                    
                                                     ReadIOPS:
                                                     [{
                                                         "time_point": "2012-09-01 23:59:59.999999",
                                                         "value": "821.818287301577",
                                                         "group_type": "db.m1.large",
                                                         "unit": "Count/Second"
                                                     }]
                                                    
                                                     WriteIOPS:
                                                     [{
                                                         "time_point": "2012-09-01 23:59:59.999999",
                                                         "value": "12374.3800034584",
                                                         "group_type": "db.m1.large",
                                                         "unit": "Count/Second"
                                                     }]

                                                    Back to top

                                                    List of EC2 instances capacity stats

                                                    /v01.1/usages/capacity_stats/ec2

                                                    Request Parameters:
                                                    Name Description Available Options Required
                                                    metric_type defines type of metric avg Yes
                                                    group defines type of data grouping instance_type, region, platform Yes
                                                    usage_type defines output data type CpuHours, RamHours Yes
                                                    interval defines the sampling step day, week, month Yes

                                                    Sample Request:
                                                    https://resource.cloudvertical.com/v01.1/usages/capacity_stats/ec2?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=CpuHours&interval=day
                                                      Sample Response:
                                                      CpuHours:
                                                       [{
                                                           "group_type": "m1.small",
                                                           "time_point": "2012-04-30",
                                                           "unit": "hours",
                                                           "value": "18000"
                                                       }]
                                                      
                                                       RamHours:
                                                       [{
                                                           "group_type": "m1.small",
                                                           "time_point": "2012-01-31",
                                                           "unit": "hours",
                                                           "value": "31805.2999999996"
                                                       }]

                                                      Back to top

                                                      List of RDS instances capacity stats

                                                      /v01.1/usages/capacity_stats/rds

                                                      Request Parameters:
                                                      Name Description Available Options Required
                                                      metric_type defines type of metric avg Yes
                                                      group defines type of data grouping instance_type, region, platform Yes
                                                      usage_type defines output data type CpuHours, RamHours Yes
                                                      interval defines the sampling step day, week, month Yes

                                                      Sample Request:
                                                      https://resource.cloudvertical.com/v01.1/usages/capacity_stats/rds?api_key=RuVm7roSnnIYwj7BVLrp&format=json&from=2012-01-01T00:00:00Z&to=2012-09-01T00:00:00Z&cloud_connection_id=123&metric_type=avg&group=instance_type&usage_type=RamHours&interval=day
                                                        Sample Response:
                                                        CpuHours:
                                                         [{
                                                             "group_type": "db.m2.xlarge",
                                                             "time_point": "2012-01-31",
                                                             "unit": "hours",
                                                             "value": "53196"
                                                         }]
                                                        
                                                         RamHours:
                                                         [{
                                                             "group_type": "db.m1.xlarge",
                                                             "time_point": "2012-07-31",
                                                             "unit": "hours",
                                                             "value": "133920"
                                                         }]

                                                        Back to top