AI-generated budget recommendations you can accept (link to a budget you created) or dismiss. Marks the suggestion as accepted and links it to an existing budget. Create the budget first via
`POST /analytics/v1/budgets`, then pass its `id` as `budgetId`. The budget must belong to your account.

ID of the budget (created via POST /analytics/v1/budgets) to link this suggestion to.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Whether the customer edited the suggested values before accepting.

Create and manage support tickets with DoiT. Adds one or more tags to an existing support request. The operation is
surgical — only the tags listed in the request are added; existing tags
on the ticket are preserved. Re-adding a tag that is already present is
a successful no-op.

All submitted tags are normalized (trim + lowercase) before storage. For
customers, the system additionally applies a `customer_tag/` namespace
prefix to prevent collisions with internal DoiT process tags. The
response echoes the actual stored strings so callers can verify the
transform.

List of tags to add or remove. Customer-submitted tags are auto-prefixed with `customer_tag/`.

Interact with Ava, DoiT's AI-powered cloud assistant. Send a question to Ava and receive a streaming response via Server-Sent Events (SSE).
The response streams back events containing the answer text, conversation ID, and message metadata.

Optional ID of an existing conversation to continue.

The question to ask Ava.

Ask DoiT AVA, the cloud cost and infrastructure expert, a question about the user's DoiT account, cloud spending, anomalies, or optimization opportunities. AVA has access to the customer's billing data, usage patterns, and DoiT-specific features. Use this for DoiT or cloud-specific questions only — not for general-purpose AI queries. Note: AVA can take a long time to respond for complex questions. If it does not respond in time, a clear error is returned with guidance to retry or simplify the question.

ID of a prior non-ephemeral conversation to continue. Requires ephemeral to be set to false — cannot be used with ephemeral: true (the default).

When true (default), the conversation is not persisted and no conversationId or answerId is returned. Set to false to receive conversationId and answerId in the response, which are needed for follow-up questions or submitting feedback.

The question to ask AVA about the user's DoiT account, cloud costs, or infrastructure.

Use this when the user wants to assign or unassign cloud resources to a label. Ask the user to confirm the assignments before executing. Do NOT use this for creating labels (use create_label) or viewing assignments (use get_label_assignments).

Array of objects to assign to the label. Each object must have objectId and objectType.

The ID of the object.

The type of the object. Accepted values: alert, allocation, budget, metric, report, annotation.

alert allocation budget metric report annotation

The ID of the label to assign or unassign objects to.

Array of objects to unassign from the label. Each object must have objectId and objectType.

Interact with Ava, DoiT's AI-powered cloud assistant. Submit feedback on an Ava answer to help improve response quality.

The specific answer ID within the conversation.

The conversation ID the feedback relates to.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Whether the feedback is positive or negative.

Optional text providing additional feedback details.

Manage CloudFlow. Creates a new CloudFlow and generates its nodes and connections based on the provided natural language intent. The operation streams incremental build events, including the ID of the newly created flow, as they are produced.

ID of an existing conversation to continue. When omitted, a new conversation is started.

Natural language description of the CloudFlow to build from scratch.

Manage users who have access to the DoiT platform. Marks the invite as `Cancelled` and invalidates the invite token so any outstanding email
links stop working. The invite document is retained (soft cancel) — the user row remains
visible in `GET /iam/v1/users` with `inviteStatus: Cancelled`. Use `DELETE /iam/v1/users/{id}`
to fully remove the record.

Returns `404` if no invite exists for the given ID, and `409` if the invite is already cancelled.

Requires `usersManager` permission.

Use this when the user wants to compare spend between two time periods (e.g. 'Compare my costs this quarter vs last quarter', 'How did January compare to February?'). Period 1 is a rolling lookback; period 2 is an explicit date range. For more than two periods or advanced comparative analysis, use run_query instead.

Filter to a specific cloud provider. Accepts aliases like "aws", "gcp", "azure".

Dimension to group by (default "service").

How many months to look back for period 1 (default 3). Includes the current month.

The comparison period as an explicit date range.

Start date in RFC3339 format (e.g. '2025-01-01T00:00:00Z').

End date in RFC3339 format (e.g. '2025-03-31T23:59:59Z').

Finalizes a pending write action (e.g. creating, updating, or deleting a resource) that was previously staged by another tool. Only call this after the user has explicitly confirmed the action summary returned by the previous tool call. If the user declined, do not call this tool — the token will expire automatically. Pass the token exactly as it was returned.

The approval token returned by a previous write/mutating tool call. Exactly as received, no quoting changes.

Use this when the user wants a simple cost breakdown by service, project, or cloud provider (e.g. 'What are my top services by cost?', 'Which projects cost the most?'). Returns the top-N items ranked by cost descending. For complex multi-filter or multi-metric queries, use run_query instead.

Dimension to group costs by. "service" = cloud service, "project" = project/account/subscription, "cloud" = cloud provider.

How many months to look back (default 1). The current in-progress month is always included.

Number of top results to return (default 10, max 25).

Use this when the user wants to see monthly spend over time (e.g. 'Show me my cost trend', 'How has my spend changed over the last 6 months?'). Returns monthly cost data points, optionally broken down by service/project/cloud. For daily granularity or custom time intervals, use run_query instead.

Optional breakdown dimension. If omitted the trend is a single total line.

How many months of history to include (default 6).

When groupBy is set, limit to top-N groups by cost (default 5).

Manage cloud provider connections and check feature availability for connected accounts. Creates or updates a CloudConnect document for an AWS account.
Unlike the CloudFormation variant, this endpoint does not update Firestore channel documents
or require a CloudFormation stack ID.

The AWS account ID.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Declares which supported AWS features the caller intends to enable. Values must match feature names configured in awsFeaturePermissions on app/cloud-connect. The value is persisted and returned in account responses. When "real-time-data" is included, s3Bucket and s3BucketRegion are required; when it is not included, s3Bucket and s3BucketRegion are not allowed.

The ARN of the IAM role created for DoiT access.

S3 bucket name for CloudTrail real-time anomaly detection. Required together with s3BucketRegion.

AWS region of the S3 bucket. Required together with s3Bucket.

Use this when the user wants to set up a new cost alert with thresholds and notification settings. Ask the user to confirm the alert parameters before executing. Do NOT use this for creating budgets (use create_budget) or viewing existing alerts (use list_alerts).

Parameters that define when and how the alert is evaluated (required).

Condition type (e.g., 'value', 'forecasted', 'percentage').

Currency code. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

USD ILS EUR AUD CAD GBP DKK NOK SEK BRL SGD MXN CHF MYR TWD EGP ZAR JPY IDR AED THB COP

The data source for the alert (e.g., 'billing').

Add a dimension to break down the evaluation of the condition.

The metric to evaluate (required). Object with 'type' and 'value' fields.

Metric type identifier (e.g., 'basic', 'custom', 'extended').

Metric value identifier (e.g., 'cost', 'usage', 'savings').

Comparison operator. Accepted values: gt, lt.

Filters that define the scope of the alert.

The field to filter on.

Set to true to exclude the values.

Filter mode. Accepted values: is, starts_with, ends_with, contains, regexp.

The dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

The time interval to evaluate the condition (required). Accepted values: hour, day, week, month, quarter, year.

The alert threshold value (required).

Alert name (required, non-empty).

List of email addresses to notify when the alert is triggered.

Use this when the user wants to create a new cost allocation rule. Ask the user to confirm the allocation parameters before executing. Do NOT use this for viewing existing allocations (use list_allocations) or labels (use create_label).

Description of the allocation's purpose

Human-readable name of the allocation

A single allocation rule that defines one grouping. Provide this for a single-rule allocation. Mutually exclusive with 'rules'

Array of allocation components that define this rule

If true, include resources with no value for this dimension

If true, exclude matching values instead of including them

Key of an existing dimension, label, or tag key

The matching mode for values

The type of the component

Values to match against

Logical formula combining components (e.g., 'A AND B')

Ordered list of allocation rules for a group allocation. Must include at least two rules. Mutually exclusive with 'rule'

Required action for this rule (e.g., 'create', 'update', 'select')

The matching mode for values

The type of the component

Values to match against

Description of the rule

Rule ID (for existing rules), required for 'update' and 'select' actions

Name of the rule

Custom label for values that do not fit into any allocation rule (required when using 'rules' for group allocations)

Use this when the user wants to add a new annotation to mark a specific date or event in cost data. Ask the user to confirm the annotation details before executing. Do NOT use this for creating labels (use create_label) or alerts (use create_alert).

The content of the annotation (required, non-empty).

List of label IDs to associate with the annotation. Labels must already exist.

List of report IDs to associate with the annotation.

The date associated with the annotation in ISO 8601 date-time format (required).

Manage cloud resources or services in your cloud environment. Creates a new asset.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Use this when the user wants to create a new cloud budget with spending limits and alert thresholds. Requires budget name, currency, type, and start period. Ask the user to confirm the budget parameters before executing. Do NOT use this for viewing existing budgets (use list_budgets or get_budget) or creating alerts (use create_alert).

List of up to three alert thresholds defined as a percentage of the amount.

Alert threshold as a percentage of the budget amount.

Budget period amount. Required if usePrevSpend is false.

List of permitted users to view/edit the budget. If provided, must include at least one collaborator with role 'owner'.

Email address of the collaborator.

Role of the collaborator. Accepted values: owner, editor, viewer.

Currency code (required). Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

Budget description.

Fixed budget end date as a UNIX timestamp in milliseconds. Required if type is fixed, must not be set for recurring.

Periodical growth percentage in recurring budgets. Must be >= 0. Defaults to 0.

Budget metric. Accepted values: cost, amortized_cost. Defaults to cost.

Budget name (required, non-empty).

Public sharing access level. Accepted values: owner, editor, viewer.

List of email addresses to notify when reaching an alert threshold.

List of Slack channels to notify when reaching an alert threshold.

Customer ID for the Slack channel.

Slack channel ID (required).

Slack channel name (required).

Whether the channel is shared.

Slack channel type.

Slack workspace identifier.

List of allocations that define the budget scope (deprecated). Exactly one of scope or scopes must be provided.

Filters that define the scope of the budget. Exactly one of scope or scopes must be provided.

The field to filter on.

Set to true to exclude the values.

Filter mode. Accepted values: is, starts_with, ends_with, contains, regexp.

The dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

List of seasonal amounts for recurring budgets with different amounts per period.

Budget start date as a UNIX timestamp in milliseconds (required).

Recurring budget interval. Required for recurring budgets. Accepted values: day, week, month, quarter, year.

Budget type (required). Accepted values: fixed, recurring.

Use the last period's spend as the target amount for recurring budgets. Defaults to false.

Use this when the user wants to create a new CloudFlow cloud provider connection (a GCP or AWS account connected for automation). Exactly one of gcpConfig or awsConfig must be supplied. Ask the user to confirm the connection details before executing. Do NOT use this to update an existing connection (use update_cloudflow_connection) or to trigger a flow (use trigger_cloud_flow).

AWS configuration. Exactly one of gcpConfig or awsConfig must be supplied.

Per-account AWS context (account ID and regions).

The AWS account ID.

The AWS regions in scope for this account.

The AWS management (payer) account ID.

The AWS organization root ID.

The permissions map for the AWS connection.

The AWS role name to assume.

Account IDs excluded from scope.

Account IDs explicitly included in scope.

Whether the management account is explicitly in scope.

Organizational unit IDs to include in scope.

List of collaborators and their roles on the connection.

The collaborator's email address.

The collaborator's role on the connection.

Optional description of the connection.

Whether the connection is enabled. Defaults to true.

GCP configuration. Exactly one of gcpConfig or awsConfig must be supplied.

A custom role definition.

The list of permissions granted by the custom role.

The ID of the custom role.

The GCP folder ID.

The Infrastructure Manager location.

The Infrastructure Manager project.

The Infrastructure Manager service account.

The scope level of the GCP connection.

The GCP organization ID.

Predefined GCP roles to grant.

The GCP project ID.

The service account used for the connection.

Human-readable connection name (required, non-empty).

Creates a new custom color theme. Requires Cloud Analytics Admin permission.

Palettes for light and dark display modes. Each palette must contain between 1 and 32 hex colors.

Colors used when the report is displayed in dark mode.

A color in hex notation. Accepts `#RGB`, `#RRGGBB`, or `#RRGGBBAA`.

Colors used when the report is displayed in light mode.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

The display name of the custom theme.

Use this when the user wants to create a new DataHub dataset. Ask the user to confirm the dataset name and description before executing. Do NOT use this for viewing datasets (use list_datahub_datasets) or sending events (use send_datahub_events).

An optional description for the dataset.

The name of the dataset (required). Allowed characters: alphanumeric (0-9,a-z,A-Z), underscore (_), dash (-), and spaces between words.

Use this when the user wants to create a new Cloud Analytics folder to organize reports and allocations. Ask the user to confirm the folder details before executing. Do NOT use this for creating reports (use create_report) or labels (use create_label).

An optional description for the folder.

The name of the folder (required, non-empty).

The ID of the parent folder. Omit or set to "root" to create at the top level.

Use this when the user wants to create a new resource label. Ask the user to confirm the label details before executing. Do NOT use this for viewing existing labels (use list_labels) or annotations (use create_annotation).

The color of the label (required). Accepted values: blue, skyBlue, teal, mint, lime, softYellow, apricot, lavender, purple, rosePink, slateGrey.

blue skyBlue teal mint lime softYellow apricot lavender purple rosePink slateGrey

The name of the label (required, non-empty).

Use this when the user wants to save a new Cloud Analytics report with a specific configuration. Ask the user to confirm the report parameters before executing. Do NOT use this for one-time queries without saving (use run_query).

Configuration for the report. Use the dimension tool to look up valid dimension IDs.

Advanced analysis options.

Include a cost forecast.

Highlight rows that are not trending.

Highlight rows trending down.

Highlight rows trending up.

How to aggregate data values. Accepted values: total, percent_total, percent_col, percent_row.

Currency code for monetary values. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

Custom time range. Only use when timeRange mode is 'custom'.

Start timestamp in RFC3339 format. Example: '2024-03-10T23:00:00Z'.

End timestamp in RFC3339 format. Example: '2024-03-12T23:00:00Z'.

Data source for the report. Accepted values: billing, bqlens, billing-datahub, kubernetes-utilization.

billing bqlens billing-datahub kubernetes-utilization

Dimensions to break down data by (columns in table view).

Dimension identifier. Use the dimension tool to get valid IDs.

Dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

How to display values in comparative reports. Accepted values: actuals_only, absolute_change, percentage_change, absolute_and_percentage.

Filters to apply to the report.

The field to filter on. Use the dimension tool to get valid IDs.

Set to true to exclude the matched values (negation).

Filter match mode. Accepted values: is, starts_with, ends_with, contains, regexp.

Dimension type of the filter field. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

Dimensions that define rows in the report (group-by).

Dimension ID for the group-by row. Use the dimension tool to get valid IDs.

Limit to top/bottom N results.

Metric used for ranking.

Sort order for the limit ranking. Accepted values: asc, desc, a_to_z.

Number of items to show.

Include promotional credits. Requires timeInterval of 'month', 'quarter', or 'year'.

Include subgroup totals. No effect when reading via API. Defaults to false.

Report layout / visualization type. Accepted values: column_chart, stacked_column_chart, bar_chart, stacked_bar_chart, line_chart, spline_chart, area_chart, area_spline_chart, stacked_area_chart, treemap_chart, table, table_heatmap, table_row_heatmap, table_col_heatmap, csv_export, sheets_export.

Deprecated: use 'metrics' instead.

Filter to limit report rows by metric value.

The metric to filter on.

Comparison operator. Accepted values: gt, lt, lte, gte, b, nb, e, ne. gt (>), lt (<), lte (<=), gte (>=), b (between), nb (not between), e (equals), ne (not equals).

Values to compare against.

List of metrics to apply (max 4). Preferred over the deprecated 'metric' field.

Metric type. Accepted values: basic, custom, extended.

For basic metrics: 'cost', 'usage', or 'savings'. For extended metrics: e.g. 'amortized_cost'. For custom metrics: the custom metric ID.

Secondary time range for comparative reports.

Number of periods to shift back (non-negative).

Custom date range for the secondary time range.

Start date in RFC3339 format.

End date in RFC3339 format.

When true, selects complete previous periods (e.g. full previous year). When false, shifts dates by amount.

Time unit for shifting. Accepted values: day, month, quarter, year.

Sort order for dimensions. Accepted values: asc, desc, a_to_z. Defaults to 'desc'. No effect when reading via API.

Sort order for groups. Accepted values: asc, desc, a_to_z. Defaults to 'asc'. No effect when reading via API.

Cost splits to apply to the report.

ID of the field to split.

Whether to include the origin in the split results.

Split mode. Accepted values: even, custom, proportional.

Origin info for cost splitting.

Origin ID.

Origin type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, gke, gke_label, unallocated.

datetime fixed optional label tag project_label system_label attribution attribution_group gke gke_label unallocated

Targets for the split.

Target ID.

Target type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label. Must match the split type unless split type is 'attribution_group', in which case target type must be 'attribution'.

Percent as float (e.g. 0.3 for 30%). Required only when split mode is 'custom'.

Type of the split. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Time interval for grouping data. Accepted values: hour, day, dayCumSum, week, isoweek, month, quarter, year, week_day.

hour day dayCumSum week isoweek month quarter year week_day

Time range for the report. Preferred over customTimeRange.

Number of time units (0–5000). Required when mode is 'last'.

Custom date range. Required when mode is 'custom'.

Start date in RFC3339 format.

End date in RFC3339 format.

Whether to include the current (in-progress) period.

Time range mode. Accepted values: last, current, custom. Use 'custom' with customTimeRange for specific dates.

Time unit. Accepted values: day, week, month, quarter, year. Required when mode is 'last'.

A brief description of the report.

Optional list of label IDs to assign to the report.

The name of the report (required, non-empty).

Use this when the user wants to create a new support ticket. Ask the user to confirm the ticket details before executing. Do NOT use this for viewing existing tickets (use list_tickets) or cloud incidents (use get_cloud_incidents).

The body of the ticket (can include html formatting)

Ticket create time

Platform of the ticket

Ticket product details

Ticket severity

The subject of the ticket.

body created platform product severity subject

Adds a comment to an existing support ticket. For customers, comments are always public. For DoiT employees, comments can be marked as private (internal notes) by setting the private field to true.

The text content of the comment (required, must be non-empty).

If true, creates a private internal note. Only honored for DoiT employees; ignored for customers.

The numeric ID of the support ticket to add a comment to.

Ingest third-party cost, usage, and metric-based data for analysis. Sends a batch of events to DataHub using a CSV file, either uncompressed or compressed in ZIP or GZ format. It may take up to 15 minutes for the data to become available in the DoiT console.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

The CSV file to upload, either uncompressed or compressed in ZIP or GZ format. The maximum file size is 30 MB. (base64-encoded file content)

The identifier of the data provider. Allowed characters: alphanumeric (0-9,a-z,A-Z), underscore (_), space, dash (-).

Manage cloud provider connections and check feature availability for connected accounts. Deletes a CloudConnect document for an AWS account.

Notifications triggered when cloud costs exceed defined thresholds or meet specific conditions. Deletes the alert specified by the Id.

Define how costs are distributed across your organization. Deletes the allocation specified by the Id.

Custom notes added to cost data to provide contextual information. Deletes the annotation specified by the Id.

Interact with Ava, DoiT's AI-powered cloud assistant. Deletes an Ava conversation by its ID.

Track actual cloud spend against planned spend. Deletes the specified budget.

Manage cloud provider connections used in CloudFlow workflows (AWS and GCP). Deletes a connection. Returns 409 if the connection is referenced by one or more flows.

Deletes the custom theme specified by the Id. Requires Cloud Analytics Admin permission.

Ingest third-party cost, usage, and metric-based data for analysis. Deletes a specific DataHub dataset.

Ingest third-party cost, usage, and metric-based data for analysis. Deletes one or more DataHub datasets and all their associated data.

List of dataset names to delete.

Ingest third-party cost, usage, and metric-based data for analysis. Deletes specific events using filters. Note that the two filters, `eventIds` and `time ranges`, are mutually exclusive.

The dataset (provider) of the events to be deleted.

The end timestamp of the time range in RFC3339 format.

Id of the event to be deleted.

The start timestamp of the time range in RFC3339 format.

Organize Cloud Analytics resources (reports, allocations) into folders. Deletes the specified folder. All nested folders will be deleted. Any reports or allocations contained in the folder are moved to the root.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Manage cloud insights representing recommendations and findings for cloud resources. Permanently deletes a single insight and all its associated resource results.
Only insights created via the public API can be deleted.

Manage cloud insights representing recommendations and findings for cloud resources. Deletes all insights matching the specified key from the batch source.
This removes the insight and all its associated resource results.
For single-insight deletion, use `DELETE /source/{sourceID}/insight/{insightKey}` instead.

Create and manage labels to organize and categorize your cloud resources. Deletes the label specified by the Id.

Manage Cloud Analytics reports and get reports data in JSON format. Deletes the specified Cloud Analytics report.

Manage users who have access to the DoiT platform. Deletes a user.

AI-generated budget recommendations you can accept (link to a budget you created) or dismiss. Marks the suggestion as dismissed so it no longer appears in the pending list.

Cloud Diagrams visualize your cloud infrastructure and resource relationships. Exports the full content of a diagram layer as a structured JSON document,
including all components and export metadata.

Manage CloudFlow. Serializes the flow — plus every flow it references through subflow nodes — into a
tenant-neutral, credential-free JSON bundle that can be imported into any tenant with
the import operation. Tenant-scoped references (connections, Datastore tables, global
variables) are declared as named requirements and rebound at import time; policy and
Slack-channel references cannot travel and are recorded as unsupported references.
The bundle never contains credentials, tenant identifiers, schedules, or execution state.

Use this when the user wants to find architecture diagrams or cloud infrastructure diagrams. Returns matching diagram files. Do NOT use this for cost analysis (use run_query) or incidents (use get_cloud_incidents).

Resource IDs to find diagrams for.

Use this when the user wants to know which color theme is currently active for their account (the theme applied to Cloud Analytics reports). Returns the active theme id; the reserved sentinel "default" means no custom or preset theme is selected and the built-in default is in use. Do NOT use this to list all themes (use list_themes) or to fetch a specific theme by id (use get_theme).

Use this when the user wants to view the details of a specific cost alert. Accepts either the alert ID or a partial name (case-insensitive). Do NOT use this for listing all alerts (use list_alerts) or anomalies (use get_anomalies).

The ID of the alert to retrieve.

Partial name match (case-insensitive). Used to find the alert when ID is unknown.

Use this when the user wants to view details of a specific cost allocation. Accepts either the allocation ID or a partial name (case-insensitive). Do NOT use this for listing all allocations (use list_allocations) or running queries (use run_query).

The ID of the allocation to retrieve.

Partial name match (case-insensitive). Used to find the allocation when ID is unknown.

Use this when the user wants to view details of a specific annotation. Accepts either the annotation ID or a partial content match (case-insensitive). Do NOT use this for listing all annotations (use list_annotations) or labels (use list_labels).

Partial content match (case-insensitive). Used to find the annotation when ID is unknown.

The ID of the annotation to retrieve.

Use this when the user wants to check for unexpected cost spikes, billing anomalies, or unusual spending patterns. Returns recent anomalies with severity and impact. Do NOT use this for optimization recommendations or savings opportunities (use list_optimization_recommendations), regular cost analysis (use run_query), or viewing alerts (use list_alerts).

Token for pagination. Use this to get the next page of results.

Use this when the user wants to view details of a specific cost anomaly by its ID. Returns full anomaly data including affected resources and cost impact. Do NOT use this for listing all anomalies (use get_anomalies).

anomaly ID

Use this when the user wants to view details of a specific cloud asset. Accepts either the asset ID or a partial name (case-insensitive). Do NOT use this for listing all assets (use list_assets) or cost analysis (use run_query).

The ID of the asset to retrieve.

Partial name match (case-insensitive). Used to find the asset when ID is unknown.

Use this when the user wants the CloudConnect details of a specific connected AWS account, such as its IAM role ARN, billing S3 bucket, and which DoiT features are enabled or supported. Requires the 12-digit AWS account ID. Do NOT use this for Google Cloud or Azure accounts.

The AWS account ID to retrieve (e.g. "123456789012").

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns a single member AWS account with the same list-item fields as List member accounts, plus the Overview time series. Use this when you need a single members Console Overview in one call (identity and onboarding status, 30-day ESR and savings, YTD/lifetime totals, monthly potential savings, and the data behind Cost Summary and Commitment Coverage charts) without fetching every member account.

Fields that drive the Overview tab in the DoiT console:
- `stats30d`: last 30 days ESR and realized savings per SP type (ESR and Savings cards).
- `monthlyStats`: last 6 calendar months of ESR, on-demand cost, and cost with savings per SP type (Cost Summary chart, and month-over-month card trends).
- `dailyCoverage`: last 30 days of commitment coverage breakdown per SP type (Commitment Coverage chart).
- `savingsTotals`: year-to-date and lifetime realized savings per SP type (shown under the Savings card). Lifetime is bounded by the parent organization's PerfectScale for Commitments onboarding start.
- `monthlyPotentialSavings`: estimated monthly additional savings per SP type from the latest purchase projection.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns a single AWS organization with the same list-item fields as List AWS Organizations, plus the Overview time series. Use this when you need a single organization's Console Overview in one call (identity and onboarding status, 30-day ESR and savings, YTD/lifetime totals, monthly potential savings, and the data behind Cost Summary and Commitment Coverage charts) without fetching every organization.

Fields that drive the Overview tab in the DoiT console:
- `stats30d`: last 30 days ESR and realized savings per SP type (ESR and Savings cards).
- `monthlyStats`: last 6 calendar months of ESR, on-demand cost, and cost with savings per SP type (Cost Summary chart, and month-over-month card trends).
- `dailyCoverage`: last 30 days of commitment coverage breakdown per SP type (Commitment Coverage chart).
- `savingsTotals`: year-to-date and lifetime realized savings per SP type (shown under the Savings card). Lifetime is bounded by PerfectScale for Commitments onboarding start.
- `monthlyPotentialSavings`: estimated monthly additional savings per SP type from the latest purchase projection.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns the recommendation for one commitment type (`serviceId`) on the AWS organization, including analysis metrics and time-bucketed eligible spend. Use `granularity` to choose the eligible-spend bucket size (defaults to `day`).

Explain month-over-month changes in invoiced cloud costs. Returns the invoiced cost changes for each payer in the authenticated tenant.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Lightweight polling surface for the onboarding wizard: returns each of the caller's PMAs
with only its IAM status/diff and timestamps — no tenant fan-out, no handshake
aggregation, no pagination. Distributor-only.

Use this when the user wants to view the details and current utilization of a specific budget. Accepts either the budget ID or a partial name (case-insensitive). Do NOT use this for listing all budgets (use list_budgets) or cost analysis (use run_query).

The ID of the budget to retrieve.

Partial name match (case-insensitive). Used to find the budget when ID is unknown.

Use this when the user wants to know which DoiT CloudConnect features a connected cloud account supports and whether the account currently has the required permissions for each feature. Accepts an AWS account ID or Azure tenant ID. Returns the list of supported features with their permission status.

The cloud provider account ID (AWS account ID or Azure tenant ID) to check supported features for.

Use this when the user wants to discover all cloud infrastructure diagrams and their layers (statussheets), or to look up layer IDs needed for other diagram endpoints. Returns all diagrams with their connected layers and optionally their component data. This is the primary discovery endpoint — use it before calling endpoints that require a layer ID. Optionally filter by diagram IDs (scheme_ids) or layer IDs (layer_ids), and set include_components=true to get full component lists. Do NOT use this for cost analysis (use run_query) or diagram search (use search_cloud_diagrams).

Include component data (nodes, elements, groups, links, etc.) in the response. Defaults to false for lighter responses. Enable when you need component IDs for other diagram endpoints.

Filter to specific layer (statussheet) IDs. Omit to return all layers.

Filter to specific diagram IDs. Omit to return all diagrams.

Exclude layers that have no components. Defaults to false.

Use this when the user wants a cost snapshot for a specific cloud infrastructure diagram layer over a time period — total spend, period-over-period trend percentage, the top resources and services by cost, and a cost trend over time. Requires the diagram layer ID and a startDate/endDate (YYYY-MM-DD). Do NOT use this for account-wide cost analysis (use run_query) or budgets (use list_budgets).

End of the period (calendar date, YYYY-MM-DD, e.g. 2026-04-30).

Bucket granularity for the cost trend. Possible values: day, week, month (defaults to day).

The diagram layer (statussheet) ID to get a cost snapshot for.

Start of the period (calendar date, YYYY-MM-DD, e.g. 2026-04-01).

Cloud Diagrams visualize your cloud infrastructure and resource relationships. Returns a single snapshot of the specified diagram layer identified by its ID.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Use this when the user wants to understand how a specific resource in a cloud infrastructure diagram is connected to other resources — its upstream/downstream edges and group membership. Returns the anchor resource plus related resources with their relation type and hop distance. Requires the diagram layer ID and the resource ID. Do NOT use this for cost analysis (use get_cloud_diagram_cost_snapshot or run_query).

How far to traverse. Possible values: direct, transitive (defaults to direct).

Relationship direction to traverse. Possible values: downstream, upstream, both (defaults to both).

Which relationship kinds to include. Possible values: edges, group_members, both (defaults to edges).

The diagram layer (statussheet) ID that contains the resource.

The ID of the resource (node, element, or group) to map relationships for.

Use this when the user wants activity statistics for their cloud infrastructure diagrams over a time period — node create/update/delete change counts grouped by cloud service, plus each diagram's import/sync state. Useful for change auditing and drift detection. Requires a start and end RFC3339 date-time.

End of the period (RFC3339 date-time, e.g. 2026-04-28T00:00:00Z).

Start of the period (RFC3339 date-time, e.g. 2026-04-01T00:00:00Z).

Use this when the user wants to view details of a specific cloud platform incident. Accepts either the incident ID or a partial title match (case-insensitive). Do NOT use this for listing all incidents (use get_cloud_incidents) or anomalies (use get_anomalies).

The ID of the cloud incident.

Partial title match (case-insensitive). Used to find the incident when ID is unknown.

Use this when the user wants to check for active cloud platform outages, service disruptions, or incidents from AWS, Google Cloud, or Azure. Do NOT use this for cost anomalies (use get_anomalies) or support tickets (use list_tickets).

Filter string in format 'key:value|key:value'. Multiple values for same key are treated as OR, different keys as AND. Example: 'platform:google-cloud|status:active' or 'platform:google-cloud|platform:amazon-web-services'

Token for pagination. Use this to get the next page of results.

platform name

amazon-web-services google-cloud-project g-suite office-365 google-cloud open-ai

Use this when the user wants a high-level overview or dashboard of their entire cloud infrastructure. Returns cost by cloud provider, top services per cloud, top projects per cloud, recent cost anomalies, and recent cloud incidents — all in a single call. Do NOT use this for detailed drill-downs (use run_query), single-provider analysis, or anomaly-only queries.

Use this when the user wants to view the details of a specific CloudFlow cloud provider connection by its ID, including its GCP/AWS configuration, collaborators, and status. Do NOT use this to list all connections (use list_cloudflow_connections) or to trigger a flow (use trigger_cloud_flow).

The ID of the CloudFlow connection to retrieve.

Use this when the user wants to view the details of a specific CloudFlow template by its ID, including its name, description, and configuration instructions. Do NOT use this to list all templates (use list_cloudflow_templates) or to trigger a flow (use trigger_cloud_flow).

The ID of the CloudFlow template to retrieve.

Returns details of a specific Enterprise Discount Program (EDP) commitment contract, identified by its ID. Includes the full breakdown of commitment periods, per-period contracted values, and current spend attainment against the committed amount.

The ID of the commitment to retrieve.

List and manage tenant-scoped contracts as a T1/T2 PartnerOps caller. Returns the specified contract.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Manage contract templates for PartnerOps resellers (T1/T2). Returns a single contract template owned by the authenticated tenant (from the bearer token). Requires ContractTemplatesAdmin, DoiT API access (`platform:externalApi`), and the `channelops:contracts:templates` entitlement.

Read and update your organization's general settings. Returns the customer, including its general settings and contact info, scoped to `{customerId}`. `{customerId}` must match the customer resolved from the bearer token; a token scoped to a different customer gets `403`, even if that customer would otherwise be reachable through a reseller/MTS relationship. Requires the `Settings` permission and DoiT API access (`platform:externalApi`).

Use this when the user wants to view details of a specific DataHub dataset by its ID. Returns full dataset metadata and schema. Do NOT use this for listing all datasets (use list_datahub_datasets) or cost queries (use run_query).

The name of the dataset to retrieve.

Use this to look up the valid filter values for a specific dimension before calling run_query — for example, call get_dimension({type: 'fixed', id: 'cloud_provider'}) to get the exact provider IDs available for this customer. Also use this when the user wants to view dimension details. Do NOT use this for listing all dimensions (use list_dimensions) or running queries (use run_query).

Dimension id

Dimension type

Explain month-over-month changes in invoiced cloud costs. Returns invoiced cost changes for an invoice owned by the specified billing profile in the authenticated tenant.

Use this when the user wants to view details of a specific Cloud Analytics folder. Accepts either the folder ID or a partial name (case-insensitive). Do NOT use this for listing all folders (use list_folders) or viewing reports (use get_report_config).

The ID of the folder to retrieve.

Partial name match (case-insensitive). Used to find the folder when ID is unknown.

Use this when the user wants the details and aggregate summary (savings, risk counts, status, description) of a single optimization insight identified by its source and key. Returns the insight metadata only — it does NOT include the individual affected resources (use get_insight_resources for those) and is not for listing all insights (use list_optimization_recommendations).

The key of the insight (e.g. 'delete-ebs-volumes'). Use the 'key' field from list_optimization_recommendations.

The source of the insight (e.g. 'aws-cost-optimization-hub', 'aws-trusted-advisor'). Use the 'source' field from list_optimization_recommendations.

Use this when the user wants to see which specific resources are affected by an optimization insight. Returns resource IDs, accounts, potential savings, and remediation details. Do NOT use this for listing all insights (use list_insights).

Use this when the user wants to view details of a specific invoice by its ID. Returns full invoice data including line items and status. Do NOT use this for listing all invoices (use list_invoices) or cost analysis (use run_query).

The ID of the invoice to retrieve.

Use this when the user wants to view details of a specific label. Accepts either the label ID or a partial name (case-insensitive). Do NOT use this for listing all labels (use list_labels) or annotations (use list_annotations).

The ID of the label to retrieve.

Partial name match (case-insensitive). Used to find the label when ID is unknown.

Use this when the user wants to see which resources are assigned to a specific label. Returns a list of assigned objects. Do NOT use this for viewing label details (use get_label) or allocations (use list_allocations).

The ID of the label to retrieve assignments for.

Get the configuration of a specific Cloud Analytics report by ID. Returns the stored report object including name, type, and a nested 'config' field containing data source, metrics, dimensions, time range, filters, and visualization settings.

The ID of the report to retrieve the configuration for.

Use this when the user wants to retrieve the data results of a specific saved report. Accepts either the report ID or a partial name (case-insensitive). Do NOT use this for listing all reports (use list_reports) or running ad-hoc queries (use run_query).

The ID of the report to retrieve results for.

Partial report name match (case-insensitive). Used to find the report when ID is unknown.

Use this when the user wants to see who a Cloud Analytics resource is shared with and at what access level. Returns the sharing settings (per-user roles and public visibility) for a specific alert, budget, report, or allocation. Requires resourceType (alerts, budgets, reports, or allocations) and resourceId. Do NOT use this to list the resources themselves (use list_alerts, list_budgets, list_reports, or list_allocations).

The ID of the resource (alert, budget, report, or allocation) to retrieve permissions for.

The type of resource to inspect sharing settings for. One of: alerts, budgets, reports, allocations.

Cloud Diagrams visualize your cloud infrastructure and resource relationships. Returns the specified components of a diagram layer. Provide at least one component
type with one or more IDs in the request body (for example, `node` or `element`).

Attachment IDs to fetch.

Combiner IDs to fetch.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Element IDs to fetch.

Group IDs to fetch.

Link IDs to fetch.

Node IDs to fetch.

Note IDs to fetch.

Use this when the user wants to view details of a specific custom color theme. Accepts either the theme ID or a partial name (case-insensitive). Do NOT use this for listing all themes (use list_themes).

The ID of the custom theme to retrieve.

Partial name match (case-insensitive). Used to find the theme when ID is unknown.

Returns details of a specific support ticket from the DoiT API by its ID.

The numeric ID of the support ticket to retrieve.

Manage cloud resources or services in your cloud environment. Updates an existing asset, such as G Suite/Workspace or Office 365 subscription, to add or remove licenses.

Manage CloudFlow. Creates every flow of a previously exported bundle in the authenticated tenant.
Imports are create-only: each call creates new draft flows with new IDs — nothing is
published and no schedule is activated until the target tenant publishes.

Requirements declared by the bundle are resolved through `bindings` (requirement key →
target-tenant resource ID). Unbound connections and Datastore tables leave the
referencing nodes flagged incomplete; unbound global variables are auto-created. Pass
`options.createMissingTables: true` to create missing Datastore tables from the schemas
embedded in the bundle (structure only, never row data).

**Dry-run**: pass `?dryRun=true` to validate without writing. The response is an import
plan: per-requirement resolutions with candidate bindings in the target tenant, the
flows that would be created, and every validation issue at once.

Requirement key → target-tenant resource ID. Keys must be declared in the bundle's requirements. Run with `?dryRun=true` first to list required keys and candidate IDs.

Portable, tenant-neutral export of one or more flows. Contains no credentials, tenant identifiers, schedules, or execution state; tenant-scoped references are declared under `requirements` and appear inside node parameters as `$req:<section>/<key>` tokens (subflow references as `$bundle:flows/<flowKey>`).

Informational export timestamp; ignored on import.

Key of this flow's entry node.

Bundle-local flow key. Opaque — the server generates new IDs at import.

Present unless the export stripped variable values. Connection-typed values are `$req:connections/<key>` tokens.

Approval configuration without recipients (recipients are tenant-scoped and removed at export).

Node parameters with tenant-scoped scalar references replaced by `$req:`/`$bundle:` tokens.

Key of the node this transition points at.

Node type (e.g. `triggerNode`, `actionNode`, `datastoreNode`). Validated against the supported node-type set at import.

Tenant-scoped references removed at export (policy IDs, Slack channels); import flags the affected nodes incomplete.

Tenant-scoped resources the bundle needs; each is bound to a target-tenant resource at import.

The source connection's display name, as a matching hint.

Cloud provider the bound connection must have (e.g. `amazon-web-services`).

Present unless the export stripped variable values.

Key (into `flows`) of the flow that was exported; the rest are its subflows.

Bundle format version. The server exports the newest version and accepts every version it has ever shipped.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Create unbound Datastore tables from the schemas embedded in the bundle (structure only, never row data). A same-named existing table with an incompatible schema is a validation error.

Optional prefix for every created flow's name.

Use this when the user wants to invite a new person to the organization. Ask the user to confirm the email, role, and organization before executing. Do NOT use this for updating existing users (use update_user) or listing users (use list_users).

The email address of the user to invite (required).

The ID of the organization to assign the invited user to.

The ID of the role to assign to the invited user.

Use this when the user wants to know who their DoiT account team / account managers are. Returns the list of account managers assigned to the customer, including name, email, role, and Calendly scheduling link. Do NOT use this for listing platform users (use list_users) or organizations (use list_organizations).

Use this when the user wants to see their cost alerts or check alert configurations. Returns a paginated list of alerts. Do NOT use this for anomaly detection (use get_anomalies) or budget tracking (use list_budgets).

Expression for filtering results. Syntax: key:[<value>]. Multiple filters joined with |. Available keys: owner, name.

Maximum number of results to return in a single page

Page token returned by a previous call to request the next page of results.

A field by which the results will be sorted.

Sort order: ascending (asc) or descending (desc).

Use this when the user wants to see their cost allocation rules or configurations. Returns a list of allocations. Supports partial name filtering. Do NOT use this for cost queries (use run_query) or labels (use list_labels).

Partial name filter (case-insensitive). Returns only allocations whose name contains this string.

Token for pagination. Use this to get the next page of results.

Use this when the user wants to see calendar annotations or notes on cost data. Returns a list of annotations. Do NOT use this for labels (use list_labels) or alerts (use list_alerts).

An expression for filtering the results. Valid fields: content, timestamp, labels. Example: content:budget

The maximum number of results to return in a single page. Defaults to 500.

Page token, returned by a previous call, to request the next page of results.

A field by which the results will be sorted. Accepted values: id, content, timestamp, timeCreated, timeModified.

id content timestamp timeCreated timeModified

The sort order for results. Accepted values: asc, desc.

Use this when the user wants to browse their cloud assets, subscriptions, or resources. Returns a paginated list of assets. Supports partial name filtering. Do NOT use this for cost analysis (use run_query) or checking invoices (use list_invoices).

An expression for filtering the results. Uses key:[value] syntax, e.g. "type:g-suite". Multiple filters can be connected using a pipe |. Different keys result in AND; same key multiple times results in OR.

The maximum number of results to return in a single page. Defaults to 100. Maximum allowed value is 249.

Partial name filter (case-insensitive). Returns only assets whose name contains this string.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns all member AWS accounts under the specified AWS organization that have active or historical commitment coverage. Includes 30-day statistics and estimated monthly potential savings (`monthlyPotentialSavings`) per Savings Plan (SP) type. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns all AWS organizations (accounts) accessible to the authenticated tenant. Use as the entry point to discover AWS organization account IDs, and organization-level onboarding status of the available commitment types and savings metrics.

Each item includes metadata, trailing 30-day aggregate statistics, precomputed YTD/lifetime savings totals per Savings Plan (SP) type, and estimated monthly potential savings (`monthlyPotentialSavings`) per SP type from the latest projection. Sum across items for customer-level totals. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns one item per onboarded AWS organization. Each item includes that AWS organization's commitments purchasing account (`purchaseAccountId`) and commitment settings for each commitment type activated on that AWS organization (`compute`, `database`).

Commitment settings cover recommendation and automation preferences (policy, term, payment option, automation mode, commitment limits, and related fields). They are stored at the customer level per commitment type and therefore have the same values on every AWS organization item. Only `purchaseAccountId` and which commitment types appear differ per AWS organization.

In the DoiT Console, commitment settings are edited on an account's Settings tab but apply across all AWS organizations for that commitment type; the purchasing account is set per AWS organization on Accounts Settings. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns planned purchases (laddering projections) for the AWS organization. One item per commitment type that has a projection available (typically `compute` and/or `database`; up to four commitment types as PerfectScale for Commitments expands).

With no filters, returns all available planned-purchase items for the AWS organization in stable commitment-type order (`compute`, then `database`, then any future commitment types in enum order). When a filtered commitment type has no planned purchases, the response is an empty `items` array (not `404`). Partial items return only the fields available at response time.

`404` is returned only when the AWS organization does not exist or the caller cannot access it. An AWS organization that is not onboarded for PerfectScale for Commitments still returns `200` with an empty `items` array when no planned purchases exist — use `GET /ps4commitments/v1/aws/organizations` (or get-by-id) for `onboardingStatus`.

**Pagination**: results are returned in stable commitment-type order (`compute`, then `database`, then any future commitment types in enum order). Use `maxResults` to limit page size (default 50, max 500). When more items remain, the response includes a non-null `pageToken`; pass it unchanged on the next request with the same query parameters (`service`, `maxResults`). `rowCount` is the number of items in this page. An invalid `pageToken` returns `400` with code `pagination_token_invalid`; an expired token returns `400` with code `pagination_token_expired`. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns commitment purchase recommendations for the AWS organization, keyed by commitment type (`compute`, `database`). A commitment type is present only when it is onboarded and a recommendation is available.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns a paginated list of Reserved Instances (RIs) for the specified AWS organization. Optionally filter by state, instance type, instance family, region, and offering class. Omit filters to return all RIs for the AWS organization. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Evaluate current AWS commitments, plan and automate purchases, and optimize cloud costs with PerfectScale for Commitments. Returns a paginated list of Savings Plans for the specified AWS organization. Optionally filter by plan type (`type`) and state (`status`). Omit both filters to return all plans for the AWS organization. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Lists the end-customer AWS account mappings under a reseller's program management
account, identified by `dpmaId` and `resellerPmaAccountId`. Callable by the reseller who
owns the PMA or the distributor who owns the DPMA.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Same result as `GET /billingtransfer/v1/end-customers`, identified by
`resellerPmaAccountId` alone (no `dpmaId` needed). Callable by the reseller who owns the
PMA or the distributor who owns its DPMA.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Lists the caller's program management accounts (PMAs) and the reseller tenants mapped to
each one, including AWS Organizations handshake status per account. Distributor-only.
 This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Lists every reseller program management account (RPMA) node belonging to the calling
reseller, with handshake state and status but without end-customer tenants — the
reseller-tier analog of `GET /billingtransfer/v1/programmanagementaccounts`.

Manage AWS billing-transfer mappings between distributors and resellers and between resellers and end customers, and list program management accounts. Lists every reseller PMA node belonging to the calling reseller, each with the
end-customer tenants connected under it — the reseller-tier analog of
`GET /billingtransfer/v1/programmanagementaccounts`. `region`, `iamStatus` and
`lastRefreshTime` are inherited from the parent DPMA root; the reseller node itself
carries no IAM/region metadata of its own.

AI-generated budget recommendations you can accept (link to a budget you created) or dismiss. Returns the pending AI-generated budget suggestions for your account. The set is small (a handful
of pending suggestions) and is returned in full. Each suggestion can be accepted (after you create a
matching budget via `POST /analytics/v1/budgets`) or dismissed.

Use this when the user wants to see their cloud spending budgets or check budget status. Returns a paginated list of budgets with names, amounts, and utilization. Do NOT use this for cost analysis (use run_query) or spending alerts (use list_alerts).

An expression for filtering the results. Syntax: "key:[<value>]". Available keys: owner, lastModified in ms (>lastModified). Multiple filters can be connected using a pipe |. Note that using different keys in the same filter results in "AND," while using the same key multiple times in the same filter results in "OR".

Max value for budget creation time, in milliseconds since the POSIX epoch. Only budgets created before or at this timestamp are returned.

The maximum number of results to return in a single page. Defaults to 50.

Min value for budget creation time, in milliseconds since the POSIX epoch. Only budgets created after or at this timestamp are returned.

Partial name filter (case-insensitive). Returns only budgets whose name contains this string.

Page token, returned by a previous call, to request the next page of results.

Use this when the user wants the change history of a cloud diagram layer grouped by snapshot. Returns snapshot activity groups for the given layer (ss_id), ordered by timestamp descending; each group references a snapshot and contains the individual activity records (node/link/group/attachment create/update/delete) that belong to it. Page with offset/limit and filter with tags. Do NOT use this for cost analysis (use run_query) or incidents (use get_cloud_incidents).

Maximum number of groups to return (default 10).

Number of groups to skip (default 0).

Layer ID to list activity groups for.

Filter activity groups by tags.

Cloud Diagrams visualize your cloud infrastructure and resource relationships. Returns the list of saved snapshots for the specified diagram layer.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Use this when the user wants the change history of a single component node in a cloud diagram layer. Returns individual activity records (NODE_CREATE/NODE_UPDATE/NODE_DELETE) for the given node (ss_id + nodeId), ordered by timestamp descending, each including the user who made the change. Page with offset/limit. Do NOT use this for cost analysis (use run_query) or incidents (use get_cloud_incidents).

Maximum number of records to return (default 50).

Node component ID.

Number of records to skip (default 0).

Layer ID the node belongs to.

Use this when the user wants to see their CloudFlow cloud provider connections (the GCP/AWS accounts connected for automation). Returns a cursor-paginated list of connections with their config and status. Do NOT use this to trigger a flow (use trigger_cloud_flow) or to view a single connection's details (use get_cloudflow_connection).

Maximum number of connections to return (1–100). Defaults to 50.

Pagination cursor returned by a previous call, to request the next page of results.

Use this when the user wants to see the catalogue of available CloudFlow templates (read-only blueprints they can build a flow from). Returns a cursor-paginated list of templates with their id, name, description, and instructions. Do NOT use this to view a single template's details (use get_cloudflow_template) or to trigger a flow (use trigger_cloud_flow).

Maximum number of templates to return (1–500). Defaults to 50.

Use this when the user wants to see their CloudFlow automation flows. Returns a cursor-paginated list of flows with their metadata, status, and last execution info.

Maximum number of flows to return (1–500). Defaults to 50.

Returns a list of commitment contracts from the DoiT Commitment Manager. These are Enterprise Discount Program (EDP) agreements — negotiated minimum spend or usage commitments between the customer and a cloud provider (Google Cloud, AWS, or Azure) .

An expression for filtering the results. Syntax: key:[<value>]. Multiple filters can be connected using pipe |. Available filter keys: name, provider. Example: provider:[google-cloud]

The maximum number of results to return in a single page. Defaults to 50.

Page token, returned by a previous call, to request the next page of results.

A field by which the results will be sorted. Accepted values: name, startDate, endDate, provider, createTime, updateTime.

name startDate endDate provider createTime updateTime

The sort order for results. Accepted values: asc, desc.

Manage contract templates for PartnerOps resellers (T1/T2). Lists contract templates owned by the authenticated tenant (from the bearer token). Requires ContractTemplatesAdmin, DoiT API access (`platform:externalApi`), and the `channelops:contracts:templates` entitlement.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

List and manage tenant-scoped contracts as a T1/T2 PartnerOps caller. Lists the contracts held by the specified customer. Callable by a T1/T2 PartnerOps principal for its own tenant or any descendant tenant. Read access requires contractsReadOnly, contractsViewer, or a write-capable role (without contractsReadOnly). User API tokens must include the matching permission in their scope.

Use this when the user wants to see available DataHub datasets. Returns a list of datasets with metadata. Do NOT use this for billing data (use run_query) or assets (use list_assets).

Use this when the user wants to see available dimensions for cost analysis queries. Returns a list of dimension types and values that can be used with run_query. Do NOT use this for running cost queries directly (use run_query) or viewing allocations (use list_allocations).

Filter string (optional) in format 'key:value|key:value'. Multiple values for same key are treated as OR, different keys as AND. The fields eligible for filtering are: type, label, key.
          use the filter parameter only if you know the exact value of the key, otherwise the filter should be empty.

Token for pagination. Use this to get the next page of results.

Use this when the user wants to see their Cloud Analytics folders, which organize reports and allocations into a hierarchy. Returns a list of folders with their metadata. Do NOT use this for listing reports (use list_reports) or labels (use list_labels).

The maximum number of results to return in a single page. Defaults to 500.

Use this when the user wants to see their invoices, check billing history, or review payment records. Returns a list of invoices with amounts, dates, and status. Do NOT use this for cost analysis (use run_query) or budget tracking (use list_budgets).

Use this when the user wants to see their resource labels or label configurations. Returns a list of labels with their metadata. Do NOT use this for annotations (use list_annotations) or label assignments (use get_label_assignments).

An expression for filtering the results. Valid fields: name, type. Example: name:budget

A field by which the results will be sorted. Accepted values: id, name, type, createTime, updateTime.

Use this when the user asks about optimization, recommendations, insights, savings opportunities, rightsizing, idle resources, security findings, or cost reduction suggestions. Also use this when the user asks 'what insights are available?' or 'show me insights'. This is the primary tool for 'what can I optimize?', 'how can I save money?', and 'what insights do I have?' questions. Returns a prioritized list of actionable insights with estimated daily savings. Do NOT use this for cost anomalies/spikes (use get_anomalies) or budget tracking (use list_budgets).

Filter by insight categories. Possible values: FinOps, OperationalExcellence, PerformanceEfficiency, Reliability, Security, Sustainability.

FinOps OperationalExcellence PerformanceEfficiency Reliability Security Sustainability

Filter by display status. Possible values: actionable, acknowledged, in progress, optimized, dismissed.

actionable
acknowledged
in progress
optimized
dismissed

Filter for easy wins only.

Page number for pagination (zero-based).

Number of results per page (default 20, max 100).

Filter by priority levels. Possible values: Low, Medium, High.

Filter by cloud provider.

Text search across insight titles and descriptions.

Use this when the user wants to see the organizations in their DoiT account. Returns a list of organizations. Do NOT use this for listing users (use list_users) or platforms (use list_platforms).

Use this when the user wants to see available cloud platforms in their DoiT account. Returns a list of platforms. Do NOT use this for cloud incidents (use get_cloud_incidents) or products (use list_products).

Use this when the user wants to see available DoiT products or services. Returns a list of products. Do NOT use this for cloud incidents (use get_cloud_incidents) or platforms (use list_platforms).

Filter products by platform

Use this when the user wants to see their saved Cloud Analytics reports or browse available reports. Returns a paginated list of reports with their IDs and metadata. Do NOT use this for running queries (use run_query) or getting report results (use get_report_results).

Filter string in format 'key:value|key:value'. Multiple values for same key are treated as OR, different keys as AND. Possible filter keys: reportName, owner, type, updateTime, use the filter property only if you know for sure the value is a valid filter key, do not guess it.

Token for pagination. Use this to get the next page of results.

Use this when the user wants to see available roles in their DoiT organization. Returns a list of roles with permissions. Do NOT use this for listing users (use list_users) or organizations (use list_organizations).

Monitor cloud service quota usage across connected accounts and projects. Returns the latest service quota usage snapshots collected by DoiT for the authenticated customer.
Results include only quotas retained by DoiT's monitoring collectors and are not a complete or live inventory from the cloud providers.
Results are sorted by utilization percentage in descending order. This endpoint is paginated: to fetch the next page, call again passing the response's `pageToken` value as the `pageToken` parameter. Stop once the response has no `pageToken` — that means there are no more pages.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Use this when the user wants to see the custom color themes defined for their account, which control the colors applied to Cloud Analytics reports. Returns a list of themes with their metadata. Do NOT use this for listing reports (use list_reports) or labels (use list_labels).

Returns all comments on a support ticket. For customers, only public comments are returned. For DoiT employees, both public and private comments are returned.

The numeric ID of the support ticket whose comments to retrieve.

Create and manage support tickets with DoiT. Returns the tags currently set on a support request.

DoiT employee (doer) callers receive the full tag set verbatim,
including internal namespaces (e.g. `tier/*`, `synapse_*`). Customer
callers receive only tags under the `customer_tag/` namespace, with
that prefix stripped (e.g. a tag added as `billing` reads back as
`billing`). Always present; empty array when the caller has no visible
tags.

Use this when the user wants to view their support tickets, check ticket status, or review open issues. Returns tickets with status, priority, and platform. Supports partial subject filtering. Do NOT use this for cloud incidents (use get_cloud_incidents) or cost alerts (use list_alerts).

Number of tickets to return per page

Page token for pagination

Partial subject filter (case-insensitive). Returns only tickets whose subject contains this string.

Use this when the user wants to see users in their DoiT organization or check who has access. Returns a list of users with roles. Do NOT use this for listing roles (use list_roles) or validating the current user (use validate_user).

Manage cloud insights representing recommendations and findings for cloud resources. Replaces all resource results for the specified insight. Any existing unresolved resource results not present in the new set will be removed. The response includes server-computed fields (severity, resolved, enhancement) for each resource result. To delete all resource results, send an empty array.

A list of resource-level results for creating or updating an insight.

A single resource-level result for creating or updating an insight. Server-computed fields (severity, resolved, enhancement) are not accepted here and will be ignored. Identity fields (resourceId, resultType, account, cloudProvider) form the composite key. The fields location and resource_type are set on creation only — any values provided for these fields during subsequent upserts are silently ignored.

The cloud account or project ID containing this resource. Immutable after creation — updates to this field are silently ignored.

Immutable after creation — updates to this field are silently ignored.

the external ID of the resource in the provider's system for the resource

the URL to the resource-level issue in the provider's system

Represents the region/zone of the resource in AWS, or equivalent for other providers. Immutable after creation — updates to this field are silently ignored.

contains any additional information for the resource results

The cloud resource identifier.

What the resource actually is, e.g. for an EC2 resource ID, this field would be `instance`. Immutable after creation — updates to this field are silently ignored.

The result data for this resource. Which fields are populated depends on the resultType. For security_risk: critical, high, medium, low. For potential_daily_savings: value. For potential_daily_savings_with_recommendation: value, current, recommendation. For potential_daily_savings_with_cluster_agent: value, agentInstalled.

true if the agent is installed

number of critical security risks

the current state (i.e. current instance type)

number of high security risks

number of low security risks

number of medium security risks

the recommended state (i.e. recommended instance type)

the daily saving amount for this result

The discriminator property that determines which fields are populated in the 'result' object.

resourceId cloudProvider account resultType

Use this when the user wants to create a new custom insight or update an existing one's metadata (title, description, categories, status, remediation links). Only insights owned by the 'public-api' source can be managed. This manages the insight's metadata only — the individual affected resources are managed separately (post_insight_resource_results). Do NOT use this only to change an insight's status (use update_insight_status).

One or more categories this insight belongs to. Possible values: FinOps, Security.

ID of a CloudFlow template that can automate the remediation of this insight.

The cloud provider associated with the insight (e.g. 'aws', 'gcp', 'azure').

A detailed description of the insight in MDX format.

Details for why the insight was dismissed (only relevant when status is 'dismissed').

An optional free-text comment providing additional context.

The reason the insight was dismissed.

not relevant
not enough information
not worth the effort
inaccurate optimization opportunities

A description of why this insight is considered an easy win.

A unique key identifying the insight within the source. Used as both the path key and body key.

URL to an external report related to this insight.

A brief summary of the insight.

The source that owns the insight. Only 'public-api' insights can be managed via this endpoint.

The display status of the insight.

actionable
acknowledged
optimized
dismissed
in progress
upgrade needed
permissions needed

The display title of the insight.

key title shortDescription cloudProvider categories

Manage cloud insights representing recommendations and findings for cloud resources. Creates or updates multiple insights in a single batch request.
Each insight in the batch includes its metadata and resource results inline.
For granular control over insight metadata and resource results independently,
use the single-insight and resource-results endpoints instead.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

List of insights to create or update.

Request body for creating or updating an insight via the batch endpoint. Includes resource results.

One or more categories this insight belongs to.

Allowed categories when creating insights via the public API.

The cloud provider associated with the resource.

A unique key for this insight within the source.

A list of resource-level results for creating or updating an insight.

The cloud account or project ID containing this resource. Immutable after creation — updates to this field are silently ignored.

Immutable after creation — updates to this field are silently ignored.

the external ID of the resource in the provider's system for the resource

the URL to the resource-level issue in the provider's system

Represents the region/zone of the resource in AWS, or equivalent for other providers. Immutable after creation — updates to this field are silently ignored.

contains any additional information for the resource results

The cloud resource identifier.

What the resource actually is, e.g. for an EC2 resource ID, this field would be `instance`. Immutable after creation — updates to this field are silently ignored.

The result data for this resource. Which fields are populated depends on the resultType. For security_risk: critical, high, medium, low. For potential_daily_savings: value. For potential_daily_savings_with_recommendation: value, current, recommendation. For potential_daily_savings_with_cluster_agent: value, agentInstalled.

true if the agent is installed

number of critical security risks

the current state (i.e. current instance type)

number of high security risks

number of low security risks

number of medium security risks

the recommended state (i.e. recommended instance type)

the daily saving amount for this result

The discriminator property that determines which fields are populated in the 'result' object.

A brief summary of the insight.

The display title of the insight.

key title shortDescription cloudProvider categories resourceResults

Use this when the user wants to refine or rebuild an existing CloudFlow automation using natural language. Streams real-time progress updates while the AI builds the flow, then returns the final result.

Optional conversation ID for multi-turn sessions

The ID of the CloudFlow flow to refine

The instruction or question to refine or rebuild the flow

Create and manage support tickets with DoiT. Removes one or more tags from an existing support request. The operation
is surgical — only the tags listed in the request are removed; tags not
listed are preserved. Removing a tag that is not present is a successful
no-op.

For customers, the system applies the same `customer_tag/` namespace
mapping as on add, so a customer who added `my_tag` (stored as
`customer_tag/my_tag`) can remove it by sending `my_tag`.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

List of tags to add or remove. Customer-submitted tags are auto-prefixed with `customer_tag/`.

Manage users who have access to the DoiT platform. Resets the invite expiry to 48 hours from now, invalidates the previous invite token (so
old email links stop working), and triggers a fresh invitation email. Works on invites in
any state including `Cancelled` — resending a cancelled invite reactivates it to `Pending`.

Returns `404` if no invite exists for the given ID (never created, or already accepted and removed).

Requires `usersManager` permission.

Use this when the user wants to analyze cloud costs, generate a cost breakdown, view spending trends, or run a custom analytics query across their cloud providers. Accepts a structured config with data source, metrics, dimensions, time range, and filters. Do NOT use this for listing saved reports (use list_reports), checking anomalies (use get_anomalies), or viewing budgets (use list_budgets).
    Fields that are not populated will use their default values if needed.
    To limit the number of rows returned per group, set the `limit.value` field inside each `config.group[]` entry (maximum 25).
    If possible, use `timeRange` instead of `customTimeRange` when no specific dates are given.
    Use "includeCurrent": true to include the current in-progress month. Use "includeCurrent": false only when asking about a fully completed past period.
    Always use "metrics" (array) not the deprecated "metric" (object).

    ALWAYS include a "group" with id "service_description" and type "fixed" unless the user explicitly asks to group by something else. This gives a per-service cost breakdown which is always the most useful default.

    Common grouping dimension IDs (all type "fixed"):
      "service_description" — cloud service (default)
      "project_id"          — GCP project / AWS account / Azure subscription (use when user asks to group by project, account, or subscription)
      "cloud_provider"      — cloud provider (AWS / GCP / Azure)

    IMPORTANT — filter values are dimension IDs, never display names. Before filtering on any dimension
    you are unsure about, call get_dimension({type, id}) to retrieve the exact valid values for this customer.
    Known cloud provider IDs (cloud_provider, type "fixed"):
      "amazon-web-services" = AWS, "google-cloud" = GCP, "microsoft-azure" = Azure

    Example — top AWS services last month:
    {
      "config": {
        "dataSource": "billing",
        "metrics": [{"type": "basic", "value": "cost"}],
        "timeRange": {"mode": "last", "amount": 1, "unit": "month", "includeCurrent": true},
        "filters": [{"id": "cloud_provider", "type": "fixed", "values": ["amazon-web-services"]}],
        "group": [{"id": "service_description", "type": "fixed", "limit": {"metric": {"type": "basic", "value": "cost"}, "sort": "desc", "value": 10}}]
      }
    }

Configuration for the query. Use the dimension tool to look up valid dimension IDs.

Advanced analysis options.

Include a cost forecast.

Highlight rows that are not trending.

Highlight rows trending down.

Highlight rows trending up.

How to aggregate data values. Accepted values: total, percent_total, percent_col, percent_row.

Currency code for monetary values. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

Custom time range. Only use when timeRange mode is 'custom'.

Start timestamp in RFC3339 format. Example: '2024-03-10T23:00:00Z'.

End timestamp in RFC3339 format. Example: '2024-03-12T23:00:00Z'.

Data source for the report. Accepted values: billing, bqlens, billing-datahub, kubernetes-utilization.

Dimensions to break down data by (columns in table view).

Dimension identifier. Use the dimension tool to get valid IDs.

Dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

How to display values in comparative reports. Accepted values: actuals_only, absolute_change, percentage_change, absolute_and_percentage.

Filters to apply to the report.

The field to filter on. Use the dimension tool to get valid IDs.

Set to true to exclude the matched values (negation).

Filter match mode. Accepted values: is, starts_with, ends_with, contains, regexp.

Dimension type of the filter field. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

Dimensions that define rows in the report (group-by).

Dimension ID for the group-by row. Use the dimension tool to get valid IDs.

Limit to top/bottom N results.

Metric used for ranking.

Sort order for the limit ranking. Accepted values: asc, desc, a_to_z.

Number of items to show.

Include promotional credits. Requires timeInterval of 'month', 'quarter', or 'year'.

Include subgroup totals. No effect when reading via API. Defaults to false.

Report layout / visualization type. Accepted values: column_chart, stacked_column_chart, bar_chart, stacked_bar_chart, line_chart, spline_chart, area_chart, area_spline_chart, stacked_area_chart, treemap_chart, table, table_heatmap, table_row_heatmap, table_col_heatmap, csv_export, sheets_export.

Deprecated: use 'metrics' instead.

Filter to limit report rows by metric value.

The metric to filter on.

Comparison operator. Accepted values: gt, lt, lte, gte, b, nb, e, ne. gt (>), lt (<), lte (<=), gte (>=), b (between), nb (not between), e (equals), ne (not equals).

Values to compare against.

List of metrics to apply (max 4). Preferred over the deprecated 'metric' field.

Metric type. Accepted values: basic, custom, extended.

For basic metrics: 'cost', 'usage', or 'savings'. For extended metrics: e.g. 'amortized_cost'. For custom metrics: the custom metric ID.

Secondary time range for comparative reports.

Number of periods to shift back (non-negative).

Custom date range for the secondary time range.

Start date in RFC3339 format.

End date in RFC3339 format.

When true, selects complete previous periods (e.g. full previous year). When false, shifts dates by amount.

Time unit for shifting. Accepted values: day, month, quarter, year.

Sort order for dimensions. Accepted values: asc, desc, a_to_z. Defaults to 'desc'. No effect when reading via API.

Sort order for groups. Accepted values: asc, desc, a_to_z. Defaults to 'asc'. No effect when reading via API.

Cost splits to apply to the report.

ID of the field to split.

Whether to include the origin in the split results.

Split mode. Accepted values: even, custom, proportional.

Origin info for cost splitting.

Origin ID.

Origin type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, gke, gke_label, unallocated.

Targets for the split.

Target ID.

Target type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label. Must match the split type unless split type is 'attribution_group', in which case target type must be 'attribution'.

Percent as float (e.g. 0.3 for 30%). Required only when split mode is 'custom'.

Type of the split. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Time interval for grouping data. Accepted values: hour, day, dayCumSum, week, isoweek, month, quarter, year, week_day.

Time range for the report. Preferred over customTimeRange.

Number of time units (0–5000). Required when mode is 'last'.

Custom date range. Required when mode is 'custom'.

Start date in RFC3339 format.

End date in RFC3339 format.

Whether to include the current (in-progress) period.

Time range mode. Accepted values: last, current, custom. Use 'custom' with customTimeRange for specific dates.

Time unit. Accepted values: day, week, month, quarter, year. Required when mode is 'last'.

Use this when the user wants to search their cloud infrastructure diagrams and components by name or property. Returns matching diagram layers (scheme), components, and components matched by property value (prop). Optionally scope to a single layer with ss_id and page with from/size. Do NOT use this for cost analysis (use run_query) or incidents (use get_cloud_incidents).

Pagination offset (default 0).

Search query string.

Maximum number of results per category (default 20).

Limit search to components within this layer (layer ID).

DoiT-internal (doer) tool: search across ALL DoiT customers by what they have — classification/kind, customer type, segment, tier package, domains, cloud asset platforms (AWS, GCP, Google Workspace, Office 365, Azure), Flexsave, standalone (direct self-serve) cloud assets, monthly cloud spend, invoiced spend over a month range, and active contracts. All provided conditions are AND-combined; within a list field the match is any-of. Returns matching customers with a summary and a nextPageToken for paging. Requires DoiT employee access (non-doers get an authorization error). Use this to FIND customers across the base; use other tools to drill into a specific customer.

Match customers that have at least one asset on any of these cloud platforms (g-suite = Google Workspace, office-365 = Microsoft 365).

amazon-web-services google-cloud g-suite office-365 microsoft-azure

Match customers in any of these classifications (the customer 'kind').

business strategic terminated inactive suspendedForNonPayment

If true, match only customers that have at least one active/expired contract.

Match customers whose primary or secondary domain is any of these.

If set, match customers that do (true) or do not (false) have Flexsave enabled on any cloud.

Start month (YYYY-MM) for the authoritative invoiced-total spend filter. Requires invoicedToMonth.

Maximum summed invoice total over the invoiced month range.

Minimum summed invoice total over the invoiced month range.

End month (YYYY-MM) for the invoiced-total spend filter. Requires invoicedFromMonth.

Maximum denormalized monthly cloud spend.

Minimum denormalized monthly cloud spend (cheap, from the customer record).

Maximum customers to return per page (default 50, max 200).

Opaque page token from a previous response's nextPageToken, to fetch the next page.

Match any of these customer segments, e.g. 'Invest', 'Incubate', 'Accelerate'.

If set, match customers that do (true) or do not (false) have at least one standalone (direct self-serve) cloud asset. true keeps standalone/hybrid customers, false keeps resold-only ones.

Match customers subscribed to any of these tier packages, e.g. 'navigator', 'solve'.

Match any of these customer types, e.g. 'procurement-only', 'product-only', 'procurement-and-product'.

Use this when the user wants to send DataHub events for ingestion (1–50,000 events per call). Each event requires a provider name and an RFC 3339 timestamp, and can optionally include dimensions and metrics. Ask the user to confirm the event count and provider details before executing. Data becomes available in Cloud Analytics within ~15 minutes. Do NOT use this for creating datasets (use create_datahub_dataset) or viewing datasets (use list_datahub_datasets).

Array of DataHub events to ingest (required). Each event requires a provider and time. Accepts 1 to 50,000 events per call.

Optional list of dimensions (key/type/value triples) to categorize this event.

The dimension key.

The dimension type. Accepted values: fixed, label, project_label, system_label.

The dimension value. Can be a string or boolean.

A unique event ID within the dataset. If omitted, a UUIDv4 is auto-generated by the server.

Optional list of metrics associated with this event.

The metric type. Use 'cost' or 'usage' to map to built-in Cloud Analytics metrics, or a custom string (e.g. 'working_hours').

The metric value (numeric).

The data provider identifier (required). Allowed characters: alphanumeric (0-9,a-z,A-Z), underscore (_), dash (-), and spaces between words. Example: 'Datadog'.

The event timestamp (required). Must be an RFC 3339 date-time string (e.g. '2024-03-10T23:00:00Z').

Use this when the user wants to change or activate a custom color theme for their Cloud Analytics reports. Accepts a theme ID or the sentinel "default" to revert to the built-in default. Ask the user to confirm the change before executing. Do NOT use this to retrieve the current active theme (use get_active_theme) or to update theme colors (use update_theme).

The ID of the theme to set as active, or the reserved sentinel "default" to revert to the built-in default (no custom theme).

Use this when the user wants to trigger an automated CloudFlow workflow by its flow ID. This executes automation that may modify cloud resources externally. Ask the user to confirm the flow ID and any parameters before executing. Do NOT use this for viewing CloudFlow definitions or checking available flows.

The ID of the CloudFlow flow to trigger

Optional JSON object to pass as the request body to the flow if the flow requires it

Use this when the user wants to modify an existing cost alert. Supports partial updates. Ask the user to confirm changes before executing. Do NOT use this for creating new alerts (use create_alert) or budgets (use create_budget).

Parameters that define when and how the alert is evaluated (required).

Condition type (e.g., 'value', 'forecasted', 'percentage').

Currency code. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

The data source for the alert (e.g., 'billing').

Add a dimension to break down the evaluation of the condition.

The metric to evaluate (required). Object with 'type' and 'value' fields.

Metric type identifier (e.g., 'basic', 'custom', 'extended').

Metric value identifier (e.g., 'cost', 'usage', 'savings').

Comparison operator. Accepted values: gt, lt.

Filters that define the scope of the alert.

The field to filter on.

Set to true to exclude the values.

Filter mode. Accepted values: is, starts_with, ends_with, contains, regexp.

The dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

The time interval to evaluate the condition (required). Accepted values: hour, day, week, month, quarter, year.

The alert threshold value (required).

The ID of the alert to update (required).

Alert name. Must be non-empty if provided.

List of email addresses to notify when the alert is triggered.

Use this when the user wants to modify an existing cost allocation. Ask the user to confirm changes before executing. Do NOT use this for creating new allocations (use create_allocation) or viewing allocations (use list_allocations).

Description of the allocation's purpose

The ID of the allocation to update

Human-readable name of the allocation

A single allocation rule that defines one grouping. Provide this for a single-rule allocation. Mutually exclusive with 'rules'

Array of allocation components that define this rule

If true, include resources with no value for this dimension

If true, exclude matching values instead of including them

Key of an existing dimension, label, or tag key

The matching mode for values

The type of the component

Values to match against

Logical formula combining components (e.g., 'A AND B')

Ordered list of allocation rules for a group allocation. Must include at least two rules. Mutually exclusive with 'rule'

Required action for this rule (e.g., 'create', 'update', 'select')

The matching mode for values

The type of the component

Values to match against

Description of the rule

Rule ID (for existing rules), required for 'update' and 'select' actions

Name of the rule

Custom label for values that do not fit into any allocation rule (required when using 'rules' for group allocations)

Use this when the user wants to modify an existing annotation. Ask the user to confirm changes before executing. Do NOT use this for creating new annotations (use create_annotation) or labels (use update_label).

The content of the annotation. Set to null to clear. Must be non-empty if provided as a string.

The ID of the annotation to update (required).

List of label IDs to associate with the annotation. Set to null to clear. Labels must already exist.

List of report IDs to associate with the annotation. Set to null to clear.

The date associated with the annotation in ISO 8601 date-time format. Set to null to clear.

Manage cloud provider connections and check feature availability for connected accounts. Updates an AWS feature for an existing CloudConnect account.
Unlike the CloudFormation variant, this endpoint does not update Firestore channel documents,
require a CloudFormation stack ID, or handle StackSet member role ARNs.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

S3 bucket name for CloudTrail real-time anomaly detection. Required together with s3BucketRegion.

AWS region of the S3 bucket. Required together with s3Bucket.

Use this when the user wants to modify an existing budget. Supports partial updates. Ask the user to confirm the changes before executing. Do NOT use this for viewing budgets (use list_budgets) or creating new budgets (use create_budget).

List of up to three alert thresholds defined as a percentage of the amount.

Alert threshold as a percentage of the budget amount.

Budget period amount.

List of permitted users to view/edit the budget. If provided, must include at least one collaborator with role 'owner'.

Email address of the collaborator.

Role of the collaborator. Accepted values: owner, editor, viewer.

Currency code. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

Budget description.

Fixed budget end date as a UNIX timestamp in milliseconds. Must not be set for recurring budgets.

Periodical growth percentage in recurring budgets. Must be >= 0. Defaults to 0.

The ID of the budget to update (required).

Budget metric. Accepted values: cost, amortized_cost. Defaults to cost.

Budget name. Must be non-empty if provided.

Public sharing access level. Accepted values: owner, editor, viewer.

List of email addresses to notify when reaching an alert threshold.

List of Slack channels to notify when reaching an alert threshold.

Customer ID for the Slack channel.

Slack channel ID (required).

Slack channel name (required).

Whether the channel is shared.

Slack channel type.

Slack workspace identifier.

List of allocations that define the budget scope (deprecated). Cannot be combined with scopes.

Filters that define the scope of the budget. Cannot be combined with scope.

The field to filter on.

Set to true to exclude the values.

Filter mode. Accepted values: is, starts_with, ends_with, contains, regexp.

The dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

List of seasonal amounts for recurring budgets with different amounts per period.

Budget start date as a UNIX timestamp in milliseconds.

Recurring budget interval. Accepted values: day, week, month, quarter, year.

Budget type. Accepted values: fixed, recurring.

Use the last period's spend as the target amount for recurring budgets. Defaults to false.

Use this when the user wants to update an existing CloudFlow cloud provider connection — rename it, change its description, enable/disable it, update its GCP/AWS configuration, or change collaborators. All fields except connectionId are optional; at most one of gcpConfig or awsConfig may be set per request. Ask the user to confirm the changes before executing. Do NOT use this to create a new connection (use create_cloudflow_connection) or to trigger a flow (use trigger_cloud_flow).

Updated AWS configuration. At most one of gcpConfig or awsConfig may be set per request.

Per-account AWS context (account ID and regions).

The AWS account ID.

The AWS regions in scope for this account.

The AWS management (payer) account ID.

The AWS organization root ID.

The permissions map for the AWS connection.

The AWS role name to assume.

Account IDs excluded from scope.

Account IDs explicitly included in scope.

Whether the management account is explicitly in scope.

Organizational unit IDs to include in scope.

Updated list of collaborators and their roles on the connection.

The collaborator's email address.

The collaborator's role on the connection.

The ID of the CloudFlow connection to update (required).

New description for the connection.

Set to false to disable the connection, true to re-enable it.

Updated GCP configuration. At most one of gcpConfig or awsConfig may be set per request.

A custom role definition.

The list of permissions granted by the custom role.

The ID of the custom role.

The GCP folder ID.

The Infrastructure Manager location.

The Infrastructure Manager project.

The Infrastructure Manager service account.

The scope level of the GCP connection.

The GCP organization ID.

Predefined GCP roles to grant.

The GCP project ID.

The service account used for the connection.

New connection name.

Read and update your organization's general settings. Partially updates the general settings and contact info of the customer identified by `{customerId}`. `{customerId}` must match the customer resolved from the bearer token; a token scoped to a different customer gets `403`, even if that customer would otherwise be reachable through a reseller/MTS relationship. Requires the `Settings` permission and DoiT API access (`platform:externalApi`); updating `allowedInviteDomains` additionally requires the `UsersManager` permission.

The request body must use `application/merge-patch+json` (RFC 7396): an omitted field leaves the current value unchanged, and an explicit `null` also leaves it unchanged, except for `urlSlug`, where an explicit empty string removes the customer's active URL slug rather than leaving it unchanged.

Fields are nested exactly as `getCustomer` returns them - `currency` and `allowedInviteDomains` under `settings`, `emails` under `contact` - so every value is read and written at the same path. `settings.currency` accepts only the codes listed in the schema and cannot be cleared; `allowedInviteDomains` and `contact.emails` are cleared with an empty array.

Customer point-of-contact details. Shared by the `getCustomer` response and the `updateCustomer` request body so a value is always read and written at the same path.

Point-of-contact email addresses for the customer.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

Customer settings. Shared by the `getCustomer` response and the `updateCustomer` request body so a value is always read and written at the same path.

`currency` accepts only the listed codes; any other value is rejected with `400`. Unlike `urlSlug` and `allowedInviteDomains` it cannot be cleared - no value unsets it.

Email domains allowed to self-invite into the customer. Updating this field requires the `UsersManager` permission in addition to `Settings`. An empty array clears the list.

Currency code for monetary values.

Whether users of this customer are required to enroll in multi-factor authentication. A missing value is treated as `true`. Disabling this does not remove MFA enrollments existing users already have.

The customer's URL display name. An explicit empty string removes the active slug; a non-empty value must be 3-12 characters of lowercase letters, digits, or dashes, starting and ending with a letter or digit, and must be unique across all customers.

Use this when the user wants to modify an existing DataHub dataset's description. The dataset name is required to identify the dataset; only the description can be changed. Ask the user to confirm the changes before executing. Do NOT use this for creating datasets (use create_datahub_dataset) or listing datasets (use list_datahub_datasets).

The new description for the dataset. At least one updatable field (description) must be provided.

The name of the dataset to update (required). Used for identification; the name cannot be changed.

Use this when the user wants to rename, re-describe, or move (reparent) an existing Cloud Analytics folder. Ask the user to confirm changes before executing. Note: if a sibling folder at the target parent already has the same name, the folder will be auto-renamed by the API. Do NOT use this for creating new folders (use create_folder) or updating reports (use update_report).

New description for the folder. Set to null to clear.

The ID of the folder to update (required).

New name for the folder.

The ID of the new parent folder, or "root" to move to the top level.

Use this when the user wants to change the display status of an existing insight (e.g. mark it acknowledged, in progress, optimized, or dismissed). Only insights owned by the 'public-api' source can be managed. When dismissing, an optional reason and comment can be supplied. Do NOT use this to edit an insight's title/description or create one (use post_insight_result).

Details for why the insight was dismissed (only relevant when status is 'dismissed').

An optional free-text comment providing additional context.

The reason the insight was dismissed.

The unique key identifying the insight to update.

The source that owns the insight. Only 'public-api' insights can be managed via this endpoint.

The new display status of the insight. Possible values: actionable, acknowledged, optimized, dismissed, in progress, upgrade needed, permissions needed.

Use this when the user wants to modify an existing label. Supports partial updates. Ask the user to confirm changes before executing. Do NOT use this for creating new labels (use create_label) or annotations (use update_annotation).

The color of the label (required). Accepted values: blue, skyBlue, teal, mint, lime, softYellow, apricot, lavender, purple, rosePink, slateGrey.

The color of the label. Accepted values: blue, skyBlue, teal, mint, lime, softYellow, apricot, lavender, purple, rosePink, slateGrey, or null to clear.

The ID of the label to update (required).

The name of the label (required, non-empty).

The name of the label. Must be non-empty if provided, or null to clear.

Use this when the user wants to modify an existing saved Cloud Analytics report. Supports partial updates. Ask the user to confirm changes before executing. Do NOT use this for running ad-hoc queries (use run_query).

Configuration for the report. Only specified fields will be updated. Use the dimension tool to look up valid dimension IDs.

Advanced analysis options.

Include a cost forecast.

Highlight rows that are not trending.

Highlight rows trending down.

Highlight rows trending up.

How to aggregate data values. Accepted values: total, percent_total, percent_col, percent_row.

Currency code for monetary values. Accepted values: USD, ILS, EUR, AUD, CAD, GBP, DKK, NOK, SEK, BRL, SGD, MXN, CHF, MYR, TWD, EGP, ZAR, JPY, IDR, AED, THB, COP.

Custom time range. Only use when timeRange mode is 'custom'.

Start timestamp in RFC3339 format. Example: '2024-03-10T23:00:00Z'.

End timestamp in RFC3339 format. Example: '2024-03-12T23:00:00Z'.

Data source for the report. Accepted values: billing, bqlens, billing-datahub, kubernetes-utilization.

Dimensions to break down data by (columns in table view).

Dimension identifier. Use the dimension tool to get valid IDs.

Dimension type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

How to display values in comparative reports. Accepted values: actuals_only, absolute_change, percentage_change, absolute_and_percentage.

Filters to apply to the report.

The field to filter on. Use the dimension tool to get valid IDs.

Set to true to exclude the matched values (negation).

Filter match mode. Accepted values: is, starts_with, ends_with, contains, regexp.

Dimension type of the filter field. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Values to filter on.

Dimensions that define rows in the report (group-by).

Dimension ID for the group-by row. Use the dimension tool to get valid IDs.

Limit to top/bottom N results.

Metric used for ranking.

Sort order for the limit ranking. Accepted values: asc, desc, a_to_z.

Number of items to show.

Include promotional credits. Requires timeInterval of 'month', 'quarter', or 'year'.

Include subgroup totals. No effect when reading via API. Defaults to false.

Report layout / visualization type. Accepted values: column_chart, stacked_column_chart, bar_chart, stacked_bar_chart, line_chart, spline_chart, area_chart, area_spline_chart, stacked_area_chart, treemap_chart, table, table_heatmap, table_row_heatmap, table_col_heatmap, csv_export, sheets_export.

Deprecated: use 'metrics' instead.

Filter to limit report rows by metric value.

The metric to filter on.

Comparison operator. Accepted values: gt, lt, lte, gte, b, nb, e, ne. gt (>), lt (<), lte (<=), gte (>=), b (between), nb (not between), e (equals), ne (not equals).

Values to compare against.

List of metrics to apply (max 4). Preferred over the deprecated 'metric' field.

Metric type. Accepted values: basic, custom, extended.

For basic metrics: 'cost', 'usage', or 'savings'. For extended metrics: e.g. 'amortized_cost'. For custom metrics: the custom metric ID.

Secondary time range for comparative reports.

Number of periods to shift back (non-negative).

Custom date range for the secondary time range.

Start date in RFC3339 format.

End date in RFC3339 format.

When true, selects complete previous periods (e.g. full previous year). When false, shifts dates by amount.

Time unit for shifting. Accepted values: day, month, quarter, year.

Sort order for dimensions. Accepted values: asc, desc, a_to_z. Defaults to 'desc'. No effect when reading via API.

Sort order for groups. Accepted values: asc, desc, a_to_z. Defaults to 'asc'. No effect when reading via API.

Cost splits to apply to the report.

ID of the field to split.

Whether to include the origin in the split results.

Split mode. Accepted values: even, custom, proportional.

Origin info for cost splitting.

Origin ID.

Origin type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, gke, gke_label, unallocated.

Targets for the split.

Target ID.

Target type. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label. Must match the split type unless split type is 'attribution_group', in which case target type must be 'attribution'.

Percent as float (e.g. 0.3 for 30%). Required only when split mode is 'custom'.

Type of the split. Accepted values: datetime, fixed, optional, label, tag, project_label, system_label, attribution, attribution_group, allocation, allocation_rule, gke, gke_label.

Time interval for grouping data. Accepted values: hour, day, dayCumSum, week, isoweek, month, quarter, year, week_day.

Time range for the report. Preferred over customTimeRange.

Number of time units (0–5000). Required when mode is 'last'.

Custom date range. Required when mode is 'custom'.

Start date in RFC3339 format.

End date in RFC3339 format.

Whether to include the current (in-progress) period.

Time range mode. Accepted values: last, current, custom. Use 'custom' with customTimeRange for specific dates.

Time unit. Accepted values: day, week, month, quarter, year. Required when mode is 'last'.

Report description.

The ID of the report to update (required).

Array of label IDs to assign to the report.

Report name.

Use this when the user wants to change who a Cloud Analytics resource is shared with or update access levels. Updates the sharing settings (per-user roles and/or public visibility) for a specific alert, budget, report, or allocation. Requires resourceType and resourceId; at least one of permissions or public should be provided. Do NOT use this to view current permissions (use get_resource_permissions).

List of per-user permission entries to set. Each entry has a user (email) and a role (owner, editor, or viewer).

Role to grant: owner, editor, or viewer.

Email address of the user.

Public visibility level. Set to 'editor' or 'viewer' to share with all users, or null to make private.

The ID of the resource (alert, budget, report, or allocation) to update permissions for.

The type of resource to update sharing settings for. One of: alerts, budgets, reports, allocations.

Use this when the user wants to modify an existing custom color theme — rename it, change its primary color, or update its color palette. Accepts either the theme ID or a partial name match. Ask the user to confirm changes before executing. Do NOT use this for creating a new theme or changing which theme is active (use set_active_theme).

New color palette for the theme. Provide both light and dark arrays.

Array of hex color values for dark mode.

Array of hex color values for light mode.

The ID of the theme to update.

Partial name match (case-insensitive) used to find the theme when ID is unknown.

New display name for the theme.

New primary hex color for the theme (e.g. #1A73E8).

Create and manage support tickets with DoiT. Partially updates a support request. Supports setting the request
`status` and/or `assignee`. DoiT employees may set any of `open`,
`pending`, `hold`, or `solved` and may set the `assignee`; customers may
set only `solved` (parity with the console "mark as resolved" action)
and may not set an assignee. `closed` is not settable via the API
(Zendesk auto-closes from `solved`). The `assignee` is a DoiT-employee
email, resolved server-side to a Zendesk agent; an email that does not
resolve to an active agent returns `400`. At least one mutable field
must be present. The response echoes the fields that were applied.

Email of the DoiT employee to assign the request to,
resolved to a Zendesk agent. DoiT employees only.

Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users.

The status to set on the request.

Use this when the user wants to update a user's information such as name, job function, phone, language, or role. Ask the user to confirm the changes before executing. Do NOT use this for inviting new users (use invite_user) or listing users (use list_users).

The user's first name.

The unique ID of the user to update.

The user's job function. Accepted values: Data Engineer / Data Analysts, Executive Team, Finance / Accounting, Founder, Legal / Purchasing, Management, Sales / Marketing, Software / Ops Engineer.

Data Engineer / Data Analysts
Executive Team
Finance / Accounting
Founder
Legal / Purchasing
Management
Sales / Marketing
Software / Ops Engineer

The user's preferred language. Accepted values: en, ja, es.

The user's last name.

The user's phone number including country calling code (e.g. +14155551234, +447911123456). Must start with a valid country calling code such as +1, +44, or +91.

The user's phone extension. Digits only, up to 15 characters.

The ID of the role to assign to the user.

Use this ONLY when the user explicitly asks to verify their account connection or check who they are logged in as. Do NOT call this proactively before other tool calls — the OAuth token already guarantees the user is authenticated. Do NOT use this for listing users in the organization (use list_users).