{ "opencollection": "1.0.0", "info": { "name": "Blue API reference Admin Cost API", "version": "v1" }, "items": [ { "info": { "name": "Cost", "type": "folder" }, "items": [ { "info": { "name": "CreateBudgetAlerts", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/alerts" }, "docs": "Create the budget alerts.\nOnly available in Wave(Pro)." }, { "info": { "name": "GetBudgetAlerts", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/alerts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required. budget alert id" } ] }, "docs": "Gets the budget alerts.\nOnly available in Wave(Pro)." }, { "info": { "name": "UpdateBudgetAlerts", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/alerts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required. budget alert id" } ] }, "docs": "Updates the budget alerts.\nOnly available in Wave(Pro)." }, { "info": { "name": "DeleteBudgetAlerts", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/alerts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Required. budget alert id" } ] }, "docs": "Deletes the budget alerts.\nOnly available in Wave(Pro)." }, { "info": { "name": "ReadBudgetAlerts", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/alerts:read" }, "docs": "Reads the budget alerts.\nOnly available in Wave(Pro).\n[ERRORS] \n- Unimplemented:\n - not implemented\n- InvalidArgument:\n - parse error" }, { "info": { "name": "Initiates an ondemand import of all registered CUR files.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/aws/cur:import" }, "docs": "See https://help.alphaus.cloud/en/articles/3612555-ripple-aws-things-you-need-to-prepare-before-starting for more information." }, { "info": { "name": "Exports RI and SP for all payers.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/exportcsv/payers:export" }, "docs": "Exports RI and SP for all payers." }, { "info": { "name": "WORK-IN-PROGRESS: Read the invoice costs. Only available in Ripple.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/invoicecosts:read" }, "docs": "WORK-IN-PROGRESS: Read the invoice costs. Only available in Ripple." }, { "info": { "name": "WORK-IN-PROGRESS: Read the invoice group costs. Only available in Ripple.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/invoicegroupcosts:read" }, "docs": "WORK-IN-PROGRESS: Read the invoice group costs. Only available in Ripple." }, { "info": { "name": "WORK-IN-PROGRESS: Read the invoice overviews. Only available in Ripple.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/invoiceoverviews:read" }, "docs": "WORK-IN-PROGRESS: Read the invoice overviews. Only available in Ripple." }, { "info": { "name": "Exports a vendor report and delivers results via email notification channel.\nSupports multiple report types per vendor. For AWS, this covers RI/SP utilization reports.\nReturns a long-running operation; use GetOperation to poll for completion.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/reports:export" }, "docs": "Exports a vendor report and delivers results via email notification channel.\nSupports multiple report types per vendor. For AWS, this covers RI/SP utilization reports.\nReturns a long-running operation; use GetOperation to poll for completion." }, { "info": { "name": "Lists all vendor accounts.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, `aws` and `gcp` is supported." }, { "name": "groupId", "value": "", "type": "query", "description": "Optional. The billing group internal id. Only valid for Ripple users." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Lists all vendor accounts." }, { "info": { "name": "Registers a vendor account.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Registers a vendor account." }, { "info": { "name": "WORK-IN-PROGRESS: Check inputed accountIds belong to current MSP or not", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts/customers/accounts:check", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "WORK-IN-PROGRESS: Check inputed accountIds belong to current MSP or not" }, { "info": { "name": "Lists all vendor accounts.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts/groups/:groupId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, `aws` and `gcp` is supported." }, { "name": "groupId", "value": "", "type": "path", "description": "Optional. The billing group internal id. Only valid for Ripple users." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Lists all vendor accounts." }, { "info": { "name": "Gets a vendor account. This API includes all of the account's metadata. See https://alphauslabs.github.io/blueapi/ for the list of supported attributes.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, `aws` and `gcp` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The account id to retrieve." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Gets a vendor account. This API includes all of the account's metadata. See https://alphauslabs.github.io/blueapi/ for the list of supported attributes." }, { "info": { "name": "WORK-IN-PROGRESS: Updates a vendor account. Only available in Ripple.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required." }, { "name": "id", "value": "", "type": "path", "description": "Required." } ] }, "docs": "WORK-IN-PROGRESS: Updates a vendor account. Only available in Ripple." }, { "info": { "name": "WORK-IN-PROGRESS: Deletes a vendor account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/accounts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The account id to delete." } ] }, "docs": "WORK-IN-PROGRESS: Deletes a vendor account." }, { "info": { "name": "Reads the non-usage-based details of an organization (Ripple) or billing group (Wave[Pro]).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/adjustments:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` or `azure` is supported." } ] }, "docs": "This API covers non-usage-based adjustments, such as Fees, Credits, Discounts, Tax, Upfront Fees, etc. At the moment, the supported `{vendor}` is `aws` or `azure`. If datetime range parameters are not set, month-to-date (current month) will be returned." }, { "info": { "name": "Get the budget alerts for the account id. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/alerts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. Account Id" } ] }, "docs": "Get the budget alerts for the account id. Only available in Wave(Pro)." }, { "info": { "name": "Create the budget alerts for the account id. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/alerts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. Account Id" } ] }, "docs": "Create the budget alerts for the account id. Only available in Wave(Pro)." }, { "info": { "name": "Update the budget alerts for the account id. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/alerts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. Account Id" } ] }, "docs": "Update the budget alerts for the account id. Only available in Wave(Pro)." }, { "info": { "name": "Delete the budget alerts for the account id. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/alerts/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. Account Id" } ] }, "docs": "Delete the budget alerts for the account id. Only available in Wave(Pro)." }, { "info": { "name": "Reads all vendor account-original-resources.\nAccount that have not been used for one month will no longer be retrieved.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/aors:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws`.`gcp`,`azure` is supported." } ] }, "docs": "Reads all vendor account-original-resources.\nAccount that have not been used for one month will no longer be retrieved." }, { "info": { "name": "Get the breakeven point details for the RI or SP.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/bep/:orgId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." }, { "name": "type", "value": "", "type": "query", "description": "Required. For AWS, \"ri\" or \"sp\"." }, { "name": "arn", "value": "", "type": "query", "description": "Required. RI/SP Arn." } ] }, "docs": "Get the breakeven point details for the RI or SP." }, { "info": { "name": "Updates monthly budget for the account/acctgroup id.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/budget/:budgetId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "budgetId", "value": "", "type": "path", "description": "Required. Budget Id" } ] }, "docs": "Updates monthly budget for the account/acctgroup id." }, { "info": { "name": "Removes monthly budget for the account/acctgroup id from database.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/budget/:budgetId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "budgetId", "value": "", "type": "path", "description": "Required. Budget Id" } ] }, "docs": "Removes monthly budget for the account/acctgroup id from database." }, { "info": { "name": "Fetches monthly budget for the account/acctgroup id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/budget/:level/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "level", "value": "", "type": "path", "description": "Required. 'account' or 'acctgroup'" }, { "name": "id", "value": "", "type": "path", "description": "Required. Account or AccountGroup Id" }, { "name": "year", "value": "", "type": "query", "description": "Optional. Default is current year. Format: `yyyy`." } ] }, "docs": "Fetches monthly budget for the account/acctgroup id." }, { "info": { "name": "Creates monthly budget for the account/acctgroup id.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/budget/:level/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "level", "value": "", "type": "path", "description": "Required. 'account' or 'acctgroup'" }, { "name": "id", "value": "", "type": "path", "description": "Required. Account or AccountGroup Id" } ] }, "docs": "Creates monthly budget for the account/acctgroup id." }, { "info": { "name": "WORK-IN-PROGRESS: List the prerequisites for cost calculations.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculation/prerequisites/:month", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "month", "value": "", "type": "path", "description": "Required. Month in format yyyy-mm." } ] }, "docs": "WORK-IN-PROGRESS: List the prerequisites for cost calculations." }, { "info": { "name": "Lists vendor costs calculations history and statuses.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculations/history", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "asOf", "value": "", "type": "query", "description": "Optional. List operations on and after this date. Format is yyyymmdd. For example, if you want to list all operations starting from June 01, 2021, set to `20210601`. If not set, defaults to the first day of the current UTC month." }, { "name": "excludeDone", "value": "", "type": "query", "description": "Optional. If true, exclude all operations that are marked as done. Include by default." } ] }, "docs": "Lists vendor costs calculations history and statuses." }, { "info": { "name": "Lists the schedules of your monthly calculations. Only available in Ripple.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculations/schedules", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Lists the schedules of your monthly calculations. Only available in Ripple." }, { "info": { "name": "Creates a schedule to trigger your monthly calculations. At the moment, only one schedule is allowed per account. Only available in Ripple.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculations/schedules", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Creates a schedule to trigger your monthly calculations. At the moment, only one schedule is allowed per account. Only available in Ripple." }, { "info": { "name": "Deletes the schedule of your monthly calculations. Only available in Ripple.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculations/schedules/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The id to delete. Can be set to either `-` or `*`, which means all." } ] }, "docs": "Deletes the schedule of your monthly calculations. Only available in Ripple." }, { "info": { "name": "WORK-IN-PROGRESS: Gets the vendor cost calculator's current configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculator/config", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "WORK-IN-PROGRESS: Gets the vendor cost calculator's current configuration." }, { "info": { "name": "Lists the cost calculator's cost modifiers. At the moment, the supported {vendor} is 'aws'. Only available in Ripple.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculator/config/costmods", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` and `azure` are supported." } ] }, "docs": "Lists the cost calculator's cost modifiers. At the moment, the supported {vendor} is 'aws'. Only available in Ripple." }, { "info": { "name": "Creates a cost modifier.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculator/config/costmods", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "A cost modifier allows you to modify the cost per lineitem. At the moment, the supported `{vendor}` is `aws` and only applies to items not affected by trueunblended calculations. Items not covered include some usages under `AmazonEC2`, `AmazonRDS`, `AmazonElastiCache`, `AmazonES`, and `AmazonRedShift`, that are covered by their respective RIs and/or SPs. Non-usage items such as discounts, refunds, fees, etc. are also not covered. Only available in Ripple." }, { "info": { "name": "Deletes a cost modifier. At the moment, the supported {vendor} is 'aws'. Only available in Ripple.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculator/config/costmods/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` and `azure` are supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The id of the modifier to delete." } ] }, "docs": "Deletes a cost modifier. At the moment, the supported {vendor} is 'aws'. Only available in Ripple." }, { "info": { "name": "Lists the vendor calculator's queued accounts for calculation.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/calculator/running:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "If result is non-empty, it means calculation is still in progress for the returned accounts. Only available in Ripple." }, { "info": { "name": "WORK-IN-PROGRESS: Reads the available cost attributes of an organization (Ripple) or billing group (Wave).", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costattrs", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "month", "value": "", "type": "query", "description": "Required. Format: `yyyy-mm`." }, { "name": "groupId", "value": "", "type": "query", "description": "Optional. If set, reads the cost attributes of this group. Only valid for Ripple users. Implied as the parent billing group for Wave(Pro) users." }, { "name": "accountId", "value": "", "type": "query", "description": "Optional. You can set it to a single account or a comma-separated list of accounts. If set, overrides `groupId`" }, { "name": "category", "value": "", "type": "query", "description": "Optional. A comma-separated list of dimensions to query. Valid values are `productCode`, `serviceCode`, `region`, `zone`, `usageType`, `instanceType`, `operation`, `invoiceId`, `description`, `resourceId` and `tags`. Sequence doesn't matter. An empty value implies all attributes will be returned." } ] }, "docs": "WORK-IN-PROGRESS: Reads the available cost attributes of an organization (Ripple) or billing group (Wave)." }, { "info": { "name": "Reads the available cost attributes of an organization (Ripple) or billing group (Wave).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costattrs:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Similar to the `ReadCosts` API but without the aggregated usages and costs. At the moment, the supported `{vendor}` is `aws`. If datetime range parameters are not set, month-to-date (current month) will be returned." }, { "info": { "name": "Lists the usage-based cost filter condition. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costfilters", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Lists the usage-based cost filter condition. Only available in Wave(Pro)." }, { "info": { "name": "Creates the usage-based cost filter condition.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costfilters", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "You can consider cost filters as predefined/prefiltered queries using the `v1/{vendor}/costs:read` or `ReadCosts` API. Only available in Wave(Pro)." }, { "info": { "name": "Updates the usage-based cost filter condition. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costfilters/:filterId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "filterId", "value": "", "type": "path", "description": "Required. Filter Id." } ] }, "docs": "Updates the usage-based cost filter condition. Only available in Wave(Pro)." }, { "info": { "name": "Deletes the usage-based cost filter condition. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costfilters/:filterId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "filterId", "value": "", "type": "path", "description": "Required. Filter Id to delete." } ] }, "docs": "Deletes the usage-based cost filter condition. Only available in Wave(Pro)." }, { "info": { "name": "Exports the usage-based cost filter condition. Only available in Wave(Pro).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costfilters/:filterId:export", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "filterId", "value": "", "type": "path", "description": "Required. Filter Id." } ] }, "docs": "Exports the usage-based cost filter condition. Only available in Wave(Pro)." }, { "info": { "name": "Triggers monthly calculations for costs and invoices at either organization or billing group level.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costs:calculate", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "For the AWS calculator, aggregation is done at daily and monthly level. Also, all occurrences of the character `|` (pipe) in the CUR descriptions and tag key/values are replaced with the `/` (forward-slash) character. This is due to the `|` character having a special designation in the data processing workflows." }, { "info": { "name": "Reads the usage-based cost details of an organization (Ripple) or billing group (Wave).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/costs:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. Supported vendors are `aws`,`azure` and `gcp`." } ] }, "docs": "You can refer to this [guide](https://labs.alphaus.cloud/docs/guides/aws-query-costs/) for more examples on how to use this API. Although the guide uses `bluectl`, the parameters are the same." }, { "info": { "name": "Get ondemand cost details for an organization (or MSP).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/coverage/ondemand/:orgId:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." } ] }, "docs": "Get ondemand cost details for an organization (or MSP)." }, { "info": { "name": "Get coverage options details for an organization (or MSP).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/coverage/options/:orgId:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." } ] }, "docs": "Get coverage options details for an organization (or MSP)." }, { "info": { "name": "Fetches cost forecasts for the specified billing group. Includes historical cost (up to previous month) and forecasted cost (up to three months for now).", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/forecasts", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "billingInternalId", "value": "", "type": "query", "description": "Optional. Company Id of Billing Group to retrieve. Default value is user's Company Id" }, { "name": "frequency", "value": "", "type": "query", "description": "Optional. Forecast frequency. Valid values are `daily` and `monthly`. \nDefault value is `daily`." }, { "name": "level", "value": "", "type": "query", "description": "Optional. Forecast granularity. Valid values are `account`, `category` and `product`. Default value is `account`." }, { "name": "fromDate", "value": "", "type": "query", "description": "Optional. Start date to get cost forecast. If from_date is less than current date, historical costs are included. If from_date is greater than current date, only forecasted costs are returned. Format: `yyyy-mm-dd`." }, { "name": "toDate", "value": "", "type": "query", "description": "Optional. End date to get cost forecast. Currently, we only support 90 days forecasting from the first day of current month. Format: `yyyy-mm-dd`." } ] }, "docs": "Fetches cost forecasts for the specified billing group. Includes historical cost (up to previous month) and forecasted cost (up to three months for now)." }, { "info": { "name": "Fetches previous month cost vs current month forecast vs current accumulated cost per category for id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/forecasts/month-on-month/:level/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "level", "value": "", "type": "path", "description": "Required. 'account' or 'acctgroup'" }, { "name": "id", "value": "", "type": "path", "description": "Required. Account or AccountGroup Id" }, { "name": "date", "value": "", "type": "query", "description": "Optional. Default is current month. Format: `yyyymm`." } ] }, "docs": "Fetches previous month cost vs current month forecast vs current accumulated cost per category for id." }, { "info": { "name": "Fetches current month daily forecast vs current accumulated daily cost for id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/forecasts/month-to-date/:level/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "level", "value": "", "type": "path", "description": "Required. 'account' or 'acctgroup'" }, { "name": "id", "value": "", "type": "path", "description": "Required. Account or AccountGroup Id" }, { "name": "date", "value": "", "type": "query", "description": "Optional. Default is current month. Format: `yyyymm`." } ] }, "docs": "Fetches current month daily forecast vs current accumulated daily cost for id." }, { "info": { "name": "Fetches monthly accumulated costs vs forecasted cost vs budget for the id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/forecasts/monthly/:level/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "level", "value": "", "type": "path", "description": "Required. 'account' or 'acctgroup'" }, { "name": "id", "value": "", "type": "path", "description": "Required. Account or AccountGroup Id" }, { "name": "fromDate", "value": "", "type": "query", "description": "Optional. Start month to get cost forecast. Format: `yyyymm`." }, { "name": "toDate", "value": "", "type": "query", "description": "Optional. Last month to get cost forecast. Format: `yyyymm`." } ] }, "docs": "Fetches monthly accumulated costs vs forecasted cost vs budget for the id." }, { "info": { "name": "Read the invoice ids. Only available in Ripple.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/invoiceids:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "Read the invoice ids. Only available in Ripple." }, { "info": { "name": "Reads the usage-based non tag costs of a billing group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/nontagcosts:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "At the moment, the supported `{vendor}` is `aws`. If datetime range parameters are not set, month-to-date (current month) will be returned." }, { "info": { "name": "Lists vendor payer accounts.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional. Get only the value that set fieldMask.\n\nsee more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto" } ] }, "docs": "For AWS, these are management accounts (formerly known as master or payer accounts); for Azure, these are subscriptions, for GCP, these are projects." }, { "info": { "name": "DEPRECATED: Registers a vendor payer account. This is now deprecated for AWS payer accounts. To register an AWS payer account, check out the 'CreateDefaultCostAccess' API.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "DEPRECATED: Registers a vendor payer account. This is now deprecated for AWS payer accounts. To register an AWS payer account, check out the 'CreateDefaultCostAccess' API." }, { "info": { "name": "WORK-IN-PROGRES: Registers a vendor payer account with their basics details such as accountId and accountName.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/basicdetails", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "WORK-IN-PROGRES: Registers a vendor payer account with their basics details such as accountId and accountName." }, { "info": { "name": "WORK-IN-PROGRES: Updates a vendor payer account's basics details.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/basicdetails/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The Payer/Management account Id to update." } ] }, "docs": "WORK-IN-PROGRES: Updates a vendor payer account's basics details." }, { "info": { "name": "Gets a vendor payer account.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The id of the account to get." } ] }, "docs": "This API includes all of the account's metadata. See (https://alphauslabs.github.io/blueapi/)[https://alphauslabs.github.io/blueapi/] for the list of supported attributes. For AWS, this means a management account (formerly known as master or payer account); for Azure, this means a subscription, for GCP, this means a project." }, { "info": { "name": "Deletes a vendor payer account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The id of the account." } ] }, "docs": "Deletes a vendor payer account." }, { "info": { "name": "WORK-IN-PROGRESS: Setup payer's billing transfer information", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/:id/billingtransfer", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. The vendor. Only 'aws' is supported for now." }, { "name": "id", "value": "", "type": "path", "description": "Required. The Payer account ID" } ] }, "docs": "WORK-IN-PROGRESS: Setup payer's billing transfer information" }, { "info": { "name": "Gets a payer account's import history.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/:id/importhistory", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The account id to query. Could be `*`, which implies all payers." }, { "name": "month", "value": "", "type": "query", "description": "Optional. The UTC month to query. If empty, defaults to current month. Format is `yyyymm`. For example, June 2021 will be `202106`." } ] }, "docs": "Import history is a list of timestamps our system tracks when the account's data are imported to our system, which in turn, triggers processing. At the moment, this only supports AWS (CUR files). You can also set `{id}` to `*` to return all payers' information under the organization." }, { "info": { "name": "Gets a payer account's proforma reports. Applicable for AWS payer accounts only.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payers/:id/proforma", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The account id to query." } ] }, "docs": "Gets a payer account's proforma reports. Applicable for AWS payer accounts only." }, { "info": { "name": "Lists vendor payer accounts with extended information. WORK IN PROGRESS", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payersextended", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional. Get only the value that set fieldMask.\n\nsee more info: https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/field_mask.proto" } ] }, "docs": "This endpoint returns additional fields beyond the standard ListPayerAccounts response.\nFor AWS, these are management accounts (formerly known as master or payer accounts); for Azure, these are subscriptions, for GCP, these are projects." }, { "info": { "name": "Gets a vendor payer account with extended information. WORK IN PROGRESS", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/payersextended/:id", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "id", "value": "", "type": "path", "description": "Required. The id of the account to get." } ] }, "docs": "This endpoint returns additional fields beyond the standard GetPayerAccount response.\nFor AWS, this means a management account (formerly known as master or payer account); for Azure, this means a subscription, for GCP, this means a project." }, { "info": { "name": "WORK-IN-PROGRESS: Get cost opmtimization recommendations for an organization (or MSP).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/recommendations/:orgId:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." } ] }, "docs": "WORK-IN-PROGRESS: Get cost opmtimization recommendations for an organization (or MSP)." }, { "info": { "name": "Get cost reduction details for an organization (or MSP).", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/reduction/:orgId:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." } ] }, "docs": "Get cost reduction details for an organization (or MSP)." }, { "info": { "name": "Reads the usage-based tag costs of a billing group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/tagcosts:read", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." } ] }, "docs": "At the moment, the supported `{vendor}` is `aws`. If datetime range parameters are not set, month-to-date (current month) will be returned." }, { "info": { "name": "Lists all vendor tags.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/tags", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "groupId", "value": "", "type": "query", "description": "Optional. The billing group internal id. Only valid for Ripple users." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Lists all vendor tags." }, { "info": { "name": "Lists all vendor tags.", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/tags/groups/:groupId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "groupId", "value": "", "type": "path", "description": "Optional. The billing group internal id. Only valid for Ripple users." }, { "name": "fieldMask", "value": "", "type": "query", "description": "Optional." } ] }, "docs": "Lists all vendor tags." }, { "info": { "name": "Get the utilization details for an organization (or MSP).", "type": "http" }, "http": { "method": "GET", "url": "https://api.alphaus.cloud/m/blue/v1/:vendor/utilization/:orgId", "params": [ { "name": "vendor", "value": "", "type": "path", "description": "Required. At the moment, only `aws` is supported." }, { "name": "orgId", "value": "", "type": "path", "description": "Required. Organization Id." }, { "name": "type", "value": "", "type": "query", "description": "Required. For AWS, \"ri\" or \"sp\"." }, { "name": "fromDate", "value": "", "type": "query", "description": "Optional. The start date of the displayed data. If not set, the first day of the current month will be used. Format: yyyy-mm-dd." }, { "name": "toDate", "value": "", "type": "query", "description": "Optional. The end date of the displayed data. If not set, current date will be used. Format: yyyy-mm-dd." }, { "name": "payerId", "value": "", "type": "query", "description": "Optional. Payer Id." }, { "name": "billingInternalId", "value": "", "type": "query", "description": "Optional. Billing group Id." }, { "name": "groupId", "value": "", "type": "query", "description": "Optional. Account group Id." }, { "name": "costGroupId", "value": "", "type": "query", "description": "Optional. Cost Group Id used in octo." } ] }, "docs": "Get the utilization details for an organization (or MSP)." } ] } ], "bundled": true }