find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/vantage-sh-financial-commitment-reports-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Vantage Financial Commitment Reports API
  description: The Vantage API provides programmatic access to the Vantage cloud cost management and FinOps platform.
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    url: https://www.vantage.sh
    email: support@vantage.sh
  version: 2.0.0
servers:
- url: https://api.vantage.sh/v2
security:
- oauth2:
  - read
tags:
- name: Financial Commitment Reports
  description: Operations about FinancialCommitmentReports
paths:
  /financial_commitment_reports:
    get:
      tags:
      - Financial Commitment Reports
      summary: Get all financial commitment reports
      description: Return all FinancialCommitmentReports.
      operationId: getFinancialCommitmentReports
      parameters:
      - name: page
        in: query
        description: The page of results to return.
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The amount of results to return. The maximum is 1000.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReports'
              example:
                links:
                  self: https://api.vantage.sh/v2/financial_commitment_reports
                  first: https://api.vantage.sh/v2/financial_commitment_reports?page=1
                  next: null
                  last: https://api.vantage.sh/v2/financial_commitment_reports?page=1
                  prev: null
                financial_commitment_reports:
                - token: fncl_cmnt_rprt_28bc840bf137769c
                  title: All Financial Commitments
                  default: false
                  created_at: '2025-01-27T21:42:06Z'
                  workspace_token: wrkspc_f8d8bd5e493a734c
                  user_token: null
                  start_date: '2024-10-01'
                  end_date: '2025-01-25'
                  date_interval: last_3_months
                  date_bucket: month
                  groupings: cost_type
                  on_demand_costs_scope: discountable
                  filter: (financial_commitments.provider = 'aws')
      security:
      - oauth2:
        - read
    post:
      tags:
      - Financial Commitment Reports
      summary: Create financial commitment report
      description: Create a FinancialCommitmentReport.
      operationId: createFinancialCommitmentReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createFinancialCommitmentReport'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
              example:
                token: fncl_cmnt_rprt_d0f702a7d0ff20a4
                title: title
                default: false
                created_at: '2025-01-27T21:42:07Z'
                workspace_token: wrkspc_609f0ae3bffb9f37
                user_token: null
                start_date: '2024-10-01'
                end_date: '2025-01-25'
                date_interval: last_3_months
                date_bucket: month
                groupings: cost_type
                on_demand_costs_scope: discountable
                filter: financial_commitments.provider = 'aws'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - write
      x-codegen-request-body-name: createFinancialCommitmentReport
  /financial_commitment_reports/{financial_commitment_report_token}:
    get:
      tags:
      - Financial Commitment Reports
      summary: Get financial commitment report by token
      description: Return a FinancialCommitmentReport.
      operationId: getFinancialCommitmentReport
      parameters:
      - name: financial_commitment_report_token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
              example:
                token: fncl_cmnt_rprt_86a93126175f91ed
                title: All Financial Commitments
                default: false
                created_at: '2025-01-27T21:42:04Z'
                workspace_token: wrkspc_0e9408c2a0682914
                user_token: null
                start_date: '2024-10-01'
                end_date: '2025-01-25'
                date_interval: last_3_months
                date_bucket: month
                groupings: cost_type
                on_demand_costs_scope: discountable
                filter: (financial_commitments.provider = 'aws')
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - read
    put:
      tags:
      - Financial Commitment Reports
      summary: Update financial commitment report
      description: Update a FinancialCommitmentReport.
      operationId: updateFinancialCommitmentReport
      parameters:
      - name: financial_commitment_report_token
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateFinancialCommitmentReport'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
              example:
                token: fncl_cmnt_rprt_38f1d3fcee354f6a
                title: new title
                default: false
                created_at: '2025-01-27T21:42:06Z'
                workspace_token: wrkspc_358df7afe2a742fb
                user_token: null
                start_date: '2024-10-01'
                end_date: '2025-01-25'
                date_interval: last_3_months
                date_bucket: week
                groupings: cost_type,commitment_type
                on_demand_costs_scope: discountable
                filter: (financial_commitments.provider = 'aws')
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - write
      x-codegen-request-body-name: updateFinancialCommitmentReport
    delete:
      tags:
      - Financial Commitment Reports
      summary: Delete financial commitment report
      description: Delete a FinancialCommitmentReport.
      operationId: deleteFinancialCommitmentReport
      parameters:
      - name: financial_commitment_report_token
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - write
components:
  schemas:
    updateFinancialCommitmentReport:
      type: object
      properties:
        title:
          type: string
          description: The title of the FinancialCommitmentReport.
        filter:
          type: string
          description: The filter query language to apply to the FinancialCommitmentReport. Additional documentation available at https://docs.vantage.sh/vql.
        start_date:
          type: string
          description: The start date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter.
          format: date
          example: '2024-03-01'
        end_date:
          type: string
          description: The end date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter.
          format: date
          example: '2024-03-01'
        date_interval:
          type: string
          description: The date interval of the FinancialCommitmentReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_3_months'.
          enum:
          - this_month
          - last_7_days
          - last_30_days
          - last_month
          - last_3_months
          - last_6_months
          - custom
          - last_12_months
          - last_24_months
          - last_36_months
          - year_to_date
          - last_3_days
          - last_14_days
        date_bucket:
          type: string
          description: The date bucket of the FinancialCommitmentReport.
          enum:
          - hour
          - day
          - week
          - month
          - quarter
        on_demand_costs_scope:
          type: string
          description: 'The scope for the costs. Possible values: discountable, all.'
          enum:
          - discountable
          - all
        groupings:
          type: array
          description: 'Grouping values for aggregating costs on the FinancialCommitmentReport. Valid groupings: cost_type, commitment_type, commitment_id, service, resource_account_id, provider_account_id, region, cost_category, cost_sub_category, instance_type, tag, tag:<label_name>.'
          items:
            type: string
      description: Update a FinancialCommitmentReport.
    createFinancialCommitmentReport:
      required:
      - title
      - workspace_token
      type: object
      properties:
        workspace_token:
          type: string
          description: The Workspace in which the FinancialCommitmentReport will be created.
        title:
          type: string
          description: The title of the FinancialCommitmentReport.
        filter:
          type: string
          description: The filter query language to apply to the FinancialCommitmentReport. Additional documentation available at https://docs.vantage.sh/vql.
        start_date:
          type: string
          description: The start date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter.
          format: date
          example: '2024-03-01'
        end_date:
          type: string
          description: The end date of the FinancialCommitmentReport. YYYY-MM-DD formatted. Incompatible with 'date_interval' parameter.
          format: date
          example: '2024-03-01'
        date_interval:
          type: string
          description: The date interval of the FinancialCommitmentReport. Unless 'custom' is used, this is incompatible with 'start_date' and 'end_date' parameters. Defaults to 'last_3_months'.
          enum:
          - this_month
          - last_7_days
          - last_30_days
          - last_month
          - last_3_months
          - last_6_months
          - custom
          - last_12_months
          - last_24_months
          - last_36_months
          - year_to_date
          - last_3_days
          - last_14_days
        date_bucket:
          type: string
          description: The date bucket of the FinancialCommitmentReport.
          enum:
          - hour
          - day
          - week
          - month
          - quarter
        on_demand_costs_scope:
          type: string
          description: 'The scope for the costs. Possible values: discountable, all.'
          enum:
          - discountable
          - all
        groupings:
          type: array
          description: 'Grouping values for aggregating costs on the FinancialCommitmentReport. Valid groupings: cost_type, commitment_type, commitment_id, service, resource_account_id, provider_account_id, region, cost_category, cost_sub_category, instance_type, tag, tag:<label_name>.'
          items:
            type: string
      description: Create a FinancialCommitmentReport.
    FinancialCommitmentReports:
      required:
      - financial_commitment_reports
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        financial_commitment_reports:
          type: array
          items:
            $ref: '#/components/schemas/FinancialCommitmentReport'
      description: FinancialCommitmentReports model
    FinancialCommitmentReport:
      required:
      - created_at
      - date_bucket
      - date_interval
      - default
      - end_date
      - filter
      - groupings
      - on_demand_costs_scope
      - start_date
      - title
      - token
      - workspace_token
      type: object
      properties:
        token:
          type: string
        title:
          type: string
          description: The title of the FinancialCommitmentReport.
          example: Acme123 Financial Commitment Report
        default:
          type: boolean
          description: Indicates whether the FinancialCommitmentReport is the default report.
        created_at:
          type: string
          description: The date and time, in UTC, the report was created. ISO 8601 Formatted.
          example: '2024-03-19T00:00:00Z'
        workspace_token:
          type: string
          description: The token for the Workspace the FinancialCommitmentReport is a part of.
        user_token:
          type:
          - string
          - 'null'
          description: The token for the User who created this FinancialCommitmentReport.
        start_date:
          type:
          - string
          - 'null'
          description: The start date for the FinancialCommitmentReport. Only set for custom date ranges. ISO 8601 Formatted.
          example: '2024-03-01'
        end_date:
          type:
          - string
          - 'null'
          description: The end date for the FinancialCommitmentReport. Only set for custom date ranges. ISO 8601 Formatted.
          example: '2024-03-20'
        date_interval:
          type:
          - string
          - 'null'
          description: The date range for the FinancialCommitmentReport. Only present if a custom date range is not specified.
          example: last_month
        date_bucket:
          type: string
          description: 'How costs are grouped and displayed in the FinancialCommitmentReport. Possible values: day, week, month.'
          example: month
        groupings:
          type:
          - string
          - 'null'
          description: The grouping aggregations applied to the filtered data.
          example: cost_type, tag:account
        on_demand_costs_scope:
          type: string
          description: 'The scope for the costs. Possible values: discountable, all.'
          example: discountable
        filter:
          type:
          - string
          - 'null'
          description: The filter applied to the FinancialCommitmentReport. Additional documentation available at https://docs.vantage.sh/vql.
      description: FinancialCommitmentReport model
    Errors:
      required:
      - errors
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        errors:
          type: array
          items:
            type: string
      description: Errors model
    Links:
      type: object
      properties:
        self:
          type:
          - string
          - 'null'
          description: The URL of the current page of results.
        first:
          type:
          - string
          - 'null'
          description: The URL of the first page of results.
        next:
          type:
          - string
          - 'null'
          description: The URL of the next page of results, if one exists.
        last:
          type:
          - string
          - 'null'
          description: The URL of the last page of results, if one exists.
        prev:
          type:
          - string
          - 'null'
          description: The URL of the previous page of results, if one exists.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access
x-original-swagger-version: '2.0'