Reference

List commitments

GET
/api/v1/commitments

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

provider?|null
kind?|

AWS writes reserved_instance and savings_plan; the Google Cloud CUD worker writes committed_use_discount and spend_commitment into the same table.

status?|null
page?Page
page_size?Page Size

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/commitments"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "items": [
      {
        "id": "string",
        "provider": "string",
        "service": "string",
        "service_label": "string",
        "account_id": "string",
        "account_name": "string",
        "region": "string",
        "kind": "reserved_instance",
        "start_date": "string",
        "end_date": "string",
        "status": "active",
        "current_utilization_pct": 0,
        "current_coverage_pct": 0,
        "monthly_commitment_usd": 0
      }
    ],
    "pagination": {
      "total_items": 0,
      "total_pages": 0,
      "current_page": 0,
      "page_size": 0,
      "has_next": true,
      "has_previous": true
    }
  }
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
Ask the FinOps Agent about your cloud spend