{ "x-generator": "NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "Costfluent Public API", "version": "v1" }, "servers": [ { "url": "http://localhost" } ], "paths": { "/v1/workspaces": { "post": { "tags": [ "Workspaces", "Workspaces" ], "summary": "Create workspace", "description": "Creates a new workspace for organizing cost data", "operationId": "CostfluentPublicApiEndpointsV1WorkspacesCreateWorkspaceEndpoint", "requestBody": { "x-name": "CreateWorkspaceRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateWorkspaceRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWorkspaceCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Workspaces", "Workspaces" ], "summary": "List workspaces", "description": "Returns all workspaces for the authenticated organization", "operationId": "CostfluentPublicApiEndpointsV1WorkspacesListWorkspacesEndpoint", "parameters": [ { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfWorkspaceResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/workspaces/{workspaceId}": { "delete": { "tags": [ "Workspaces", "Workspaces" ], "summary": "Delete workspace", "description": "Deletes a workspace. Associated data may be retained.", "operationId": "CostfluentPublicApiEndpointsV1WorkspacesDeleteWorkspaceEndpoint", "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Workspaces", "Workspaces" ], "summary": "Get workspace", "description": "Returns details of a specific workspace", "operationId": "CostfluentPublicApiEndpointsV1WorkspacesGetWorkspaceEndpoint", "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWorkspaceResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Workspaces", "Workspaces" ], "summary": "Update workspace", "description": "Updates workspace settings", "operationId": "CostfluentPublicApiEndpointsV1WorkspacesUpdateWorkspaceEndpoint", "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateWorkspaceRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateWorkspaceRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWorkspaceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/virtual-tags/{virtualTagId}/activate": { "post": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Activate virtual tag", "description": "Activates an inactive virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsActivateVirtualTagEndpoint", "parameters": [ { "name": "virtualTagId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/virtual-tags": { "post": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Create virtual tag", "description": "Creates a new virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsCreateVirtualTagEndpoint", "requestBody": { "x-name": "CreateVirtualTagRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateVirtualTagRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesVirtualTagCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "List virtual tags", "description": "Returns all virtual tags for a workspace", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsListVirtualTagsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "activeOnly", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfVirtualTagResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/virtual-tags/{virtualTagId}/deactivate": { "post": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Deactivate virtual tag", "description": "Deactivates a virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsDeactivateVirtualTagEndpoint", "parameters": [ { "name": "virtualTagId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/virtual-tags/{virtualTagId}": { "delete": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Delete virtual tag", "description": "Deletes a virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsDeleteVirtualTagEndpoint", "parameters": [ { "name": "virtualTagId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Get virtual tag", "description": "Returns a specific virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsGetVirtualTagEndpoint", "parameters": [ { "name": "virtualTagId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesVirtualTagResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "patch": { "tags": [ "Virtual Tags", "Virtual-Tags" ], "summary": "Update virtual tag", "description": "Updates a virtual tag", "operationId": "CostfluentPublicApiEndpointsV1VirtualTagsUpdateVirtualTagEndpoint", "parameters": [ { "name": "virtualTagId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateVirtualTagRouteRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1VirtualTagsUpdateVirtualTagRouteRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/me": { "get": { "tags": [ "Utility", "Me" ], "summary": "Get current token info", "description": "Returns information about the current API token context", "operationId": "CostfluentPublicApiEndpointsV1UtilityMeEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesMeResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/ping": { "get": { "tags": [ "Utility", "Ping" ], "summary": "Health check", "description": "Returns API status and version", "operationId": "CostfluentPublicApiEndpointsV1UtilityPingEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesPingResponse" } } } } } } }, "/v1/tag-keys/{tagKeyId}": { "delete": { "tags": [ "Tags", "Tag-Keys" ], "summary": "Delete tag key", "description": "Deletes a tag key", "operationId": "CostfluentPublicApiEndpointsV1TagsDeleteTagKeyEndpoint", "parameters": [ { "name": "tagKeyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsTagKeyPublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Tags", "Tag-Keys" ], "summary": "Get tag key", "description": "Returns a specific tag key", "operationId": "CostfluentPublicApiEndpointsV1TagsGetTagKeyEndpoint", "parameters": [ { "name": "tagKeyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsTagKeyPublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesTagKeyResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/tag-keys": { "get": { "tags": [ "Tags", "Tag-Keys" ], "summary": "List tag keys", "description": "Returns all discovered tag keys for the organization", "operationId": "CostfluentPublicApiEndpointsV1TagsListTagKeysEndpoint", "parameters": [ { "name": "providerKey", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfTagKeyResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/saved-filters": { "post": { "tags": [ "Saved Filters", "Saved-Filters" ], "summary": "Create saved filter", "description": "Creates a reusable filter configuration", "operationId": "CostfluentPublicApiEndpointsV1SavedFiltersCreateSavedFilterEndpoint", "requestBody": { "x-name": "CreateSavedFilterRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateSavedFilterRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSavedFilterCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Saved Filters", "Saved-Filters" ], "summary": "List saved filters", "description": "Returns all saved filters for a workspace", "operationId": "CostfluentPublicApiEndpointsV1SavedFiltersListSavedFiltersEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfSavedFilterResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/saved-filters/{filterId}": { "delete": { "tags": [ "Saved Filters", "Saved-Filters" ], "summary": "Delete saved filter", "description": "Deletes a saved filter", "operationId": "CostfluentPublicApiEndpointsV1SavedFiltersDeleteSavedFilterEndpoint", "parameters": [ { "name": "filterId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSavedFilterPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Saved Filters", "Saved-Filters" ], "summary": "Get saved filter", "description": "Returns a specific saved filter", "operationId": "CostfluentPublicApiEndpointsV1SavedFiltersGetSavedFilterEndpoint", "parameters": [ { "name": "filterId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSavedFilterPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSavedFilterResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Saved Filters", "Saved-Filters" ], "summary": "Update saved filter", "description": "Updates a saved filter", "operationId": "CostfluentPublicApiEndpointsV1SavedFiltersUpdateSavedFilterEndpoint", "parameters": [ { "name": "filterId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSavedFilterPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateSavedFilterRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1SavedFiltersUpdateSavedFilterRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSavedFilterResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers": { "post": { "tags": [ "Providers", "Providers" ], "summary": "Connect provider", "description": "Connects a new cloud provider, platform, or integration for cost monitoring", "operationId": "CostfluentPublicApiEndpointsV1ProvidersConnectProviderEndpoint", "requestBody": { "x-name": "ConnectProviderRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsConnectProviderRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Providers", "Providers" ], "summary": "List providers", "description": "Returns all connected providers for the authenticated organization", "operationId": "CostfluentPublicApiEndpointsV1ProvidersListProvidersEndpoint", "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfProviderResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/{providerId}": { "delete": { "tags": [ "Providers", "Providers" ], "summary": "Delete provider", "description": "Disconnects and removes a provider. Associated cost data may be retained.", "operationId": "CostfluentPublicApiEndpointsV1ProvidersDeleteProviderEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Providers", "Providers" ], "summary": "Get provider", "description": "Returns details of a specific provider", "operationId": "CostfluentPublicApiEndpointsV1ProvidersGetProviderEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/available": { "get": { "tags": [ "Providers", "Providers" ], "summary": "Get available providers", "description": "Returns all supported provider types and their configuration requirements", "operationId": "CostfluentPublicApiEndpointsV1ProvidersGetAvailableProvidersEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderDefinitionResponse" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/{providerId}/sync-history": { "get": { "tags": [ "Providers", "Providers" ], "summary": "Get provider sync history", "description": "Returns sync history for a provider", "operationId": "CostfluentPublicApiEndpointsV1ProvidersGetProviderSyncHistoryEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1ProvidersSyncHistoryResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/{providerId}/test": { "post": { "tags": [ "Providers", "Providers" ], "summary": "Test provider connection", "description": "Validates credentials and connectivity to the provider", "operationId": "CostfluentPublicApiEndpointsV1ProvidersTestProviderConnectionEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesConnectionTestResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/{providerId}/sync": { "post": { "tags": [ "Providers", "Providers" ], "summary": "Trigger provider sync", "description": "Initiates a cost data sync from the provider. Use fullSync=true for complete re-sync.", "operationId": "CostfluentPublicApiEndpointsV1ProvidersTriggerProviderSyncEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "TriggerProviderSyncRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsTriggerProviderSyncRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSyncTriggerResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/providers/{id}": { "put": { "tags": [ "Providers", "Providers" ], "summary": "Update provider", "description": "Updates provider settings, credentials, or configuration", "operationId": "CostfluentPublicApiEndpointsV1ProvidersUpdateProviderEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateProviderRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateProviderRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/folders": { "post": { "tags": [ "Folders", "Folders" ], "summary": "Create folder", "description": "Creates a new folder for organizing reports", "operationId": "CostfluentPublicApiEndpointsV1FoldersCreateFolderEndpoint", "requestBody": { "x-name": "CreateFolderRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateFolderRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Folders", "Folders" ], "summary": "List folders", "description": "Returns all folders for a workspace as a tree", "operationId": "CostfluentPublicApiEndpointsV1FoldersListFoldersEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/folders/{folderId}": { "delete": { "tags": [ "Folders", "Folders" ], "summary": "Delete folder", "description": "Deletes a folder. Reports in the folder are moved to root.", "operationId": "CostfluentPublicApiEndpointsV1FoldersDeleteFolderEndpoint", "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Folders", "Folders" ], "summary": "Get folder", "description": "Returns a specific folder", "operationId": "CostfluentPublicApiEndpointsV1FoldersGetFolderEndpoint", "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Folders", "Folders" ], "summary": "Update folder", "description": "Updates folder title or parent", "operationId": "CostfluentPublicApiEndpointsV1FoldersUpdateFolderEndpoint", "parameters": [ { "name": "folderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateFolderRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateFolderRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/exchange-rates/currencies": { "get": { "tags": [ "Exchange Rates", "Exchange-Rates" ], "summary": "Get available currencies", "description": "Returns all available currencies for exchange rate lookups", "operationId": "CostfluentPublicApiEndpointsV1ExchangeRatesGetAvailableCurrenciesEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAvailableCurrenciesResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/exchange-rates/rate": { "get": { "tags": [ "Exchange Rates", "Exchange-Rates" ], "summary": "Get exchange rate", "description": "Returns the exchange rate for a currency pair on a specific date", "operationId": "CostfluentPublicApiEndpointsV1ExchangeRatesGetExchangeRateEndpoint", "parameters": [ { "name": "baseCurrency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "targetCurrency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "schema": { "type": "string", "format": "date", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesExchangeRateResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/workspaces/{workspaceId}/exchange-rates/policy": { "get": { "tags": [ "Exchange Rates", "Workspaces" ], "summary": "Get the workspace\u0027s exchange rate policy", "description": "The conversion method, the named rate source, and the period the policy applies to. Read-only: the policy is an accounting decision recorded with the account, not a setting.", "operationId": "CostfluentPublicApiEndpointsV1ExchangeRatesGetFxPolicyEndpoint", "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentFeaturesExchangeRatesResponsesFxPolicyStatusResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/exchange-rates": { "get": { "tags": [ "Exchange Rates", "Exchange-Rates" ], "summary": "List exchange rates", "description": "Returns exchange rates for a specific date (defaults to today)", "operationId": "CostfluentPublicApiEndpointsV1ExchangeRatesListExchangeRatesEndpoint", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string", "format": "date", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesExchangeRateListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/dashboards": { "post": { "tags": [ "Dashboards", "Dashboards" ], "summary": "Create dashboard", "description": "Creates a new dashboard", "operationId": "CostfluentPublicApiEndpointsV1DashboardsCreateDashboardEndpoint", "requestBody": { "x-name": "CreateDashboardRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateDashboardRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesDashboardCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Dashboards", "Dashboards" ], "summary": "List dashboards", "description": "Returns all dashboards for a workspace", "operationId": "CostfluentPublicApiEndpointsV1DashboardsListDashboardsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfDashboardResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/dashboards/{dashboardId}": { "delete": { "tags": [ "Dashboards", "Dashboards" ], "summary": "Delete dashboard", "description": "Deletes a dashboard and all its widgets", "operationId": "CostfluentPublicApiEndpointsV1DashboardsDeleteDashboardEndpoint", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Dashboards", "Dashboards" ], "summary": "Get dashboard", "description": "Returns a specific dashboard with widgets", "operationId": "CostfluentPublicApiEndpointsV1DashboardsGetDashboardEndpoint", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesDashboardResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Dashboards", "Dashboards" ], "summary": "Update dashboard", "description": "Updates a dashboard", "operationId": "CostfluentPublicApiEndpointsV1DashboardsUpdateDashboardEndpoint", "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateDashboardRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1DashboardsUpdateDashboardRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesDashboardResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/custom-providers/{providerId}/costs": { "post": { "tags": [ "Custom Provider", "Custom-Providers" ], "summary": "Submit costs batch", "description": "Submits a batch of cost records to a custom provider. Supports idempotency via Idempotency-Key header.", "operationId": "CostfluentPublicApiEndpointsV1CustomProviderSubmitCostsEndpoint", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "SubmitCostsRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsSubmitCostsRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSubmitCostsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-report-subscriptions/{subscriptionId}/activate": { "post": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Activate report notification", "description": "Activates a paused report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsActivateCostReportSubscriptionEndpoint", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-report-subscriptions": { "post": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Create report notification", "description": "Creates a new scheduled report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsCreateCostReportSubscriptionEndpoint", "requestBody": { "x-name": "CreateCostReportSubscriptionRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateCostReportSubscriptionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "List report notifications", "description": "Returns all report notifications for a workspace", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsListCostReportSubscriptionsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "costReportId", "in": "query", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" } ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-report-subscriptions/{subscriptionId}/deactivate": { "post": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Deactivate report notification", "description": "Deactivates a report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsDeactivateCostReportSubscriptionEndpoint", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-report-subscriptions/{subscriptionId}": { "delete": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Delete report notification", "description": "Deletes a report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsDeleteCostReportSubscriptionEndpoint", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Get report notification", "description": "Returns a specific report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsGetCostReportSubscriptionEndpoint", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "patch": { "tags": [ "Report Notifications", "Cost-Report-Subscriptions" ], "summary": "Update report notification", "description": "Updates a report notification", "operationId": "CostfluentPublicApiEndpointsV1CostReportSubscriptionsUpdateCostReportSubscriptionEndpoint", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateCostReportSubscriptionRouteRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1CostReportSubscriptionsUpdateCostReportSubscriptionRouteRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-reports": { "post": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "Create cost report", "description": "Creates a new cost report configuration", "operationId": "CostfluentPublicApiEndpointsV1CostReportsCreateCostReportEndpoint", "requestBody": { "x-name": "CreateCostReportRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateCostReportRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "List cost reports", "description": "Returns all cost reports for a workspace, optionally filtered by folder", "operationId": "CostfluentPublicApiEndpointsV1CostReportsListCostReportsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "folderId", "in": "query", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] } }, { "name": "includeFolderSummary", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-reports/{costReportId}": { "delete": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "Delete cost report", "description": "Deletes a cost report", "operationId": "CostfluentPublicApiEndpointsV1CostReportsDeleteCostReportEndpoint", "parameters": [ { "name": "costReportId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "Get cost report", "description": "Returns a specific cost report configuration", "operationId": "CostfluentPublicApiEndpointsV1CostReportsGetCostReportEndpoint", "parameters": [ { "name": "costReportId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "Update cost report", "description": "Updates a cost report configuration", "operationId": "CostfluentPublicApiEndpointsV1CostReportsUpdateCostReportEndpoint", "parameters": [ { "name": "costReportId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateCostReportRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1CostReportsUpdateCostReportRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-reports/{costReportId}/data": { "get": { "tags": [ "Cost Reports", "Cost-Reports" ], "summary": "Get cost report data", "description": "Returns the computed cost data for a report", "operationId": "CostfluentPublicApiEndpointsV1CostReportsGetCostReportDataEndpoint", "parameters": [ { "name": "costReportId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportDataResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/costs": { "get": { "tags": [ "Cost Data", "Costs" ], "summary": "Get cost data", "description": "Returns cost data for one optional grouping dimension, filtered by the supplied cost filter", "operationId": "CostfluentPublicApiEndpointsV1CostDataGetCostDataEndpoint", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "granularity", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "cloudAccountIds", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "nullable": true, "items": { "type": "string" } } }, { "name": "filter", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "includeCredits", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "includeRefunds", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "includeTax", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "amortize", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostDataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/costs/forecast": { "get": { "tags": [ "Cost Data", "Costs" ], "summary": "Get cost forecast", "description": "Returns cost forecast for the upcoming months", "operationId": "CostfluentPublicApiEndpointsV1CostDataGetCostForecastEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1CostDataCostForecastResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/costs/summary": { "get": { "tags": [ "Cost Data", "Costs" ], "summary": "Get cost summary", "description": "Returns aggregated cost summary with comparisons", "operationId": "CostfluentPublicApiEndpointsV1CostDataGetCostSummaryEndpoint", "parameters": [ { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "cloudAccountIds", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "nullable": true, "items": { "type": "string" } } }, { "name": "filter", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "includeCredits", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "includeRefunds", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "includeTax", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "amortize", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostSummaryResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-alerts": { "post": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Create cost alert", "description": "Creates a new cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsCreateCostAlertEndpoint", "requestBody": { "x-name": "CreateCostAlertRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateCostAlertRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostAlertCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "List cost alerts", "description": "Returns all cost alerts for a workspace", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsListCostAlertsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfCostAlertResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-alerts/{alertId}": { "delete": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Delete cost alert", "description": "Deletes a cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsDeleteCostAlertEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Get cost alert", "description": "Returns a specific cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsGetCostAlertEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostAlertResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Update cost alert", "description": "Updates a cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsUpdateCostAlertEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateCostAlertRouteRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1CostAlertsUpdateCostAlertRouteRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-alerts/{alertId}/events": { "get": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Get cost alert events", "description": "Returns triggered events for a cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsGetCostAlertEventsEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostAlertEventListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-alerts/{alertId}/pause": { "post": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Pause cost alert", "description": "Pauses evaluation of a cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsPauseCostAlertEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/cost-alerts/{alertId}/resume": { "post": { "tags": [ "Cost Alerts", "Cost-Alerts" ], "summary": "Resume cost alert", "description": "Resumes evaluation of a paused cost alert", "operationId": "CostfluentPublicApiEndpointsV1CostAlertsResumeCostAlertEndpoint", "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/contracting/data-processing-agreement": { "get": { "tags": [ "Contracting", "Contracting" ], "summary": "Get the data processing agreement status", "description": "Whether this account\u0027s tier is sold with a signed data processing agreement, whether one is currently in force, and why cost collection is paused if it is. Read-only: the agreement is executed outside the product and recorded by us.", "operationId": "CostfluentPublicApiEndpointsV1ContractingGetDataProcessingAgreementEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentFeaturesContractingResponsesDpaStatusResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/budgets": { "post": { "tags": [ "Budgets", "Budgets" ], "summary": "Create budget", "description": "Creates a new budget with optional alert thresholds", "operationId": "CostfluentPublicApiEndpointsV1BudgetsCreateBudgetEndpoint", "requestBody": { "x-name": "CreateBudgetRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCreateBudgetRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesBudgetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem\u002Bjson": { "schema": { "$ref": "#/components/schemas/FastEndpointsProblemDetails" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Budgets", "Budgets" ], "summary": "List budgets", "description": "Returns all budgets, optionally filtered by workspace", "operationId": "CostfluentPublicApiEndpointsV1BudgetsListBudgetsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" } ] } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedResponseOfBudgetResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/budgets/{budgetId}": { "delete": { "tags": [ "Budgets", "Budgets" ], "summary": "Delete budget", "description": "Deletes a budget and its alert configuration", "operationId": "CostfluentPublicApiEndpointsV1BudgetsDeleteBudgetEndpoint", "parameters": [ { "name": "budgetId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsBudgetPublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "get": { "tags": [ "Budgets", "Budgets" ], "summary": "Get budget", "description": "Returns a specific budget with current spend", "operationId": "CostfluentPublicApiEndpointsV1BudgetsGetBudgetEndpoint", "parameters": [ { "name": "budgetId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsBudgetPublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesBudgetResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "put": { "tags": [ "Budgets", "Budgets" ], "summary": "Update budget", "description": "Updates a budget name, amount, or filter", "operationId": "CostfluentPublicApiEndpointsV1BudgetsUpdateBudgetEndpoint", "parameters": [ { "name": "budgetId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsBudgetPublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateBudgetRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateBudgetRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesBudgetResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/entitlement": { "get": { "tags": [ "Billing", "Entitlement" ], "summary": "Get the account\u0027s entitlement", "description": "The tier, every limit it carries, any limit raised for this account, and the published ladder so a caller can see what the next plan lifts.", "operationId": "CostfluentPublicApiEndpointsV1BillingGetEntitlementEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentFeaturesEntitlementsResponsesEntitlementResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/usage": { "get": { "tags": [ "Billing", "Usage" ], "summary": "Get the account\u0027s metered usage", "description": "The same numbers the caps are enforced against, so a script can check headroom rather than discover a limit by being refused.", "operationId": "CostfluentPublicApiEndpointsV1BillingGetUsageEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentFeaturesEntitlementsResponsesUsageResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/anomalies/{anomalyId}/acknowledge": { "post": { "tags": [ "Anomalies", "Anomalies" ], "summary": "Acknowledge anomaly", "description": "Marks an anomaly as acknowledged", "operationId": "CostfluentPublicApiEndpointsV1AnomaliesAcknowledgeAnomalyEndpoint", "parameters": [ { "name": "anomalyId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAnomalyPublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/anomalies": { "get": { "tags": [ "Anomalies", "Anomalies" ], "summary": "List anomalies", "description": "Returns detected cost anomalies with optional filtering", "operationId": "CostfluentPublicApiEndpointsV1AnomaliesListAnomaliesEndpoint", "parameters": [ { "name": "cloudAccountId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "severity", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "unacknowledgedOnly", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date", "nullable": true } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date", "nullable": true } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAnomalyListResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/allocation/rules": { "get": { "tags": [ "Allocation", "Allocation" ], "summary": "List allocation rules", "description": "Returns the workspace\u0027s rules in compiled precedence order. The order is the meaning of the set, so this is also the export.", "operationId": "CostfluentPublicApiEndpointsV1AllocationListAllocationRulesEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationRuleResponse" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "post": { "tags": [ "Allocation", "Allocation" ], "summary": "Create an allocation rule", "operationId": "CostfluentPublicApiEndpointsV1AllocationCreateAllocationRuleEndpoint", "requestBody": { "x-name": "CreateAllocationRuleRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationCreateAllocationRuleRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationRuleResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/allocation/rules/{ruleId}": { "put": { "tags": [ "Allocation", "Allocation" ], "summary": "Update an allocation rule", "operationId": "CostfluentPublicApiEndpointsV1AllocationUpdateAllocationRuleEndpoint", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAllocationRulePublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateAllocationRuleRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationUpdateAllocationRuleRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationRuleResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "delete": { "tags": [ "Allocation", "Allocation" ], "summary": "Delete an allocation rule", "description": "Allocation is evaluated at query time, so removing a rule restates every past month immediately.", "operationId": "CostfluentPublicApiEndpointsV1AllocationDeleteAllocationRuleEndpoint", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAllocationRulePublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/allocation/rules/order": { "post": { "tags": [ "Allocation", "Allocation" ], "summary": "Reorder the allocation rule set", "operationId": "CostfluentPublicApiEndpointsV1AllocationReorderAllocationRulesEndpoint", "requestBody": { "x-name": "ReorderAllocationRulesRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationReorderAllocationRulesRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationRuleResponse" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/allocation/coverage": { "get": { "tags": [ "Allocation", "Allocation" ], "summary": "Read allocation coverage", "operationId": "CostfluentPublicApiEndpointsV1AllocationGetAllocationCoverageEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } }, { "name": "windowStart", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "windowEndExclusive", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "costBasis", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentFeaturesCostAllocationQueriesAllocationCoverageResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/segments": { "get": { "tags": [ "Allocation", "Segments" ], "summary": "List segments", "description": "Returns every segment cost can be assigned to in a workspace", "operationId": "CostfluentPublicApiEndpointsV1AllocationListSegmentsEndpoint", "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSegmentResponse" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "post": { "tags": [ "Allocation", "Segments" ], "summary": "Create a segment", "operationId": "CostfluentPublicApiEndpointsV1AllocationCreateSegmentEndpoint", "requestBody": { "x-name": "CreateSegmentRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationCreateSegmentRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSegmentResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/segments/{segmentId}": { "put": { "tags": [ "Allocation", "Segments" ], "summary": "Update a segment", "operationId": "CostfluentPublicApiEndpointsV1AllocationUpdateSegmentEndpoint", "parameters": [ { "name": "segmentId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSegmentPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "requestBody": { "x-name": "UpdateSegmentRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationUpdateSegmentRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSegmentResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] }, "delete": { "tags": [ "Allocation", "Segments" ], "summary": "Delete a segment", "description": "Refused while any rule still assigns cost to it", "operationId": "CostfluentPublicApiEndpointsV1AllocationDeleteSegmentEndpoint", "parameters": [ { "name": "segmentId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSegmentPublicId" }, "example": { "Value": "Value" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "example": { "Value": "Value" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } }, "/v1/allocation/rules/preview": { "post": { "tags": [ "Allocation", "Allocation" ], "summary": "Preview an allocation rule", "description": "Computes what the rule would move without creating it. Allocation is evaluated at query time, so enabling a rule restates history immediately.", "operationId": "CostfluentPublicApiEndpointsV1AllocationPreviewAllocationRuleEndpoint", "requestBody": { "x-name": "PreviewAllocationRuleRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1AllocationPreviewAllocationRuleRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationDryRunResponse" } } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "ApiTokenAuth": [] } ] } } }, "components": { "schemas": { "CostfluentPublicApiModelsV1ResponsesWorkspaceCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsWorkspacePublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateWorkspaceRequest": { "type": "object", "additionalProperties": false, "required": [ "name", "currency" ], "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "currency": { "type": "string", "maxLength": 3, "minLength": 3, "nullable": false } } }, "FastEndpointsProblemDetails": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "default": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1" }, "title": { "type": "string", "default": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "default": 400 }, "instance": { "type": "string", "default": "/api/route" }, "traceId": { "type": "string", "default": "0HMPNHL0JHL76:00000001" }, "detail": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/FastEndpointsProblemDetails_Error" } } } }, "FastEndpointsProblemDetails_Error": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "default": "Error or field name" }, "reason": { "type": "string", "default": "Error reason" }, "code": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true } } }, "CostfluentPublicApiEndpointsV1WorkspacesDeleteWorkspaceRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesWorkspaceResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "currency" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string" }, "currency": { "type": "string" }, "enableCurrencyConversion": { "type": "boolean" }, "providerCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1WorkspacesGetWorkspaceRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfWorkspaceResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWorkspaceResponse" } } } }, "CostfluentPublicApiModelsV1CommonPaginationLinks": { "type": "object", "additionalProperties": false, "required": [ "self" ], "properties": { "self": { "type": "string" }, "first": { "type": "string", "nullable": true }, "prev": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true }, "last": { "type": "string", "nullable": true } } }, "CostfluentPublicApiModelsV1CommonPaginatedRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1RequestsUpdateWorkspaceRequest": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": true }, "currency": { "type": "string", "maxLength": 3, "minLength": 3, "nullable": true }, "enableCurrencyConversion": { "type": "boolean", "nullable": true } } }, "CostfluentPublicApiEndpointsV1VirtualTagsActivateVirtualTagRequest": { "type": "object", "additionalProperties": false }, "CostfluentSharedKernelPublicIdsVirtualTagPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesVirtualTagCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "key" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "key": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateVirtualTagRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "key", "computationMode", "rules" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "key": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": false }, "computationMode": { "$ref": "#/components/schemas/CostfluentDomainEnumsComputationMode" }, "rules": { "type": "string", "minLength": 1, "nullable": false }, "description": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } } }, "CostfluentDomainEnumsComputationMode": { "type": "string", "description": "", "x-enumNames": [ "Precompute", "QueryTime" ], "enum": [ "precompute", "queryTime" ] }, "CostfluentPublicApiEndpointsV1VirtualTagsDeactivateVirtualTagRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1VirtualTagsDeleteVirtualTagRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesVirtualTagResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "key", "computationMode", "rules", "status" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsVirtualTagPublicId" }, "key": { "type": "string" }, "description": { "type": "string", "nullable": true }, "computationMode": { "type": "string" }, "rules": { "type": "string" }, "defaultValue": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "lastComputedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1VirtualTagsGetVirtualTagRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfVirtualTagResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesVirtualTagResponse" } } } }, "CostfluentPublicApiEndpointsV1VirtualTagsListVirtualTagsRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiEndpointsV1VirtualTagsUpdateVirtualTagRouteRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateVirtualTagRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiModelsV1RequestsUpdateVirtualTagRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "key": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": true }, "description": { "type": "string", "nullable": true }, "computationMode": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsComputationMode" } ] }, "rules": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesMeResponse": { "type": "object", "additionalProperties": false, "required": [ "organizationId", "tokenType", "tokenName", "capabilities" ], "properties": { "organizationId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsOrganizationPublicId" }, "workspaceId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" } ] }, "tokenType": { "type": "string" }, "tokenName": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string" } } } }, "CostfluentSharedKernelPublicIdsOrganizationPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesPingResponse": { "type": "object", "additionalProperties": false, "required": [ "status", "timestamp", "version" ], "properties": { "status": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "version": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1TagsDeleteTagKeyRequest": { "type": "object", "additionalProperties": false }, "CostfluentSharedKernelPublicIdsTagKeyPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesTagKeyResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "key", "providerKeys" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsTagKeyPublicId" }, "key": { "type": "string" }, "providerKeys": { "type": "array", "items": { "type": "string" } }, "valueCount": { "type": "integer", "format": "int32" }, "lastSeenAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } }, "CostfluentPublicApiEndpointsV1TagsGetTagKeyRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfTagKeyResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesTagKeyResponse" } } } }, "CostfluentPublicApiEndpointsV1TagsListTagKeysRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiModelsV1ResponsesSavedFilterCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSavedFilterPublicId" }, "title": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsSavedFilterPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateSavedFilterRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "title", "filter" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "title": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "filter": { "type": "string", "maxLength": 4000, "minLength": 0, "nullable": false }, "isDefault": { "type": "boolean" } } }, "CostfluentPublicApiEndpointsV1SavedFiltersDeleteSavedFilterRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesSavedFilterResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title", "filter" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSavedFilterPublicId" }, "title": { "type": "string" }, "filter": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CostfluentPublicApiEndpointsV1SavedFiltersGetSavedFilterRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfSavedFilterResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesSavedFilterResponse" } } } }, "CostfluentPublicApiEndpointsV1SavedFiltersListSavedFiltersRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiEndpointsV1SavedFiltersUpdateSavedFilterRequest": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "nullable": true }, "filter": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesProviderCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "type", "key", "name" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "type": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsProviderPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsConnectProviderRequest": { "type": "object", "additionalProperties": false, "required": [ "key", "credentials" ], "properties": { "key": { "type": "string", "minLength": 1, "nullable": false }, "name": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": true }, "description": { "type": "string", "maxLength": 1000, "minLength": 0, "nullable": true }, "parentProviderId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" } ] }, "externalId": { "type": "string", "nullable": true }, "credentials": { "type": "object", "minLength": 1, "nullable": false, "additionalProperties": { "type": "string" } }, "settings": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "syncFrequencyMinutes": { "type": "integer", "format": "int32", "maximum": 1440.0, "minimum": 60.0 } } }, "CostfluentPublicApiEndpointsV1ProvidersDeleteProviderRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesProviderDefinitionResponse": { "type": "object", "additionalProperties": false, "required": [ "key", "type", "displayName", "requiredCredentialFields", "optionalSettingFields", "kind" ], "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "displayName": { "type": "string" }, "iconUrl": { "type": "string", "nullable": true }, "requiresParentProvider": { "type": "boolean" }, "requiredCredentialFields": { "type": "array", "items": { "type": "string" } }, "optionalSettingFields": { "type": "array", "items": { "type": "string" } }, "kind": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesProviderResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "type", "key", "name", "status" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "type": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "parentProviderId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" } ] }, "externalId": { "type": "string", "nullable": true }, "lastSyncAt": { "type": "string", "format": "date-time", "nullable": true }, "lastSyncStatus": { "type": "string", "nullable": true }, "lastSyncError": { "type": "string", "nullable": true }, "nextSyncAt": { "type": "string", "format": "date-time", "nullable": true }, "syncFrequencyMinutes": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1ProvidersGetProviderRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1ProvidersSyncHistoryResponse": { "type": "object", "additionalProperties": false, "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1ProvidersSyncHistoryEntryResponse" } } } }, "CostfluentPublicApiEndpointsV1ProvidersSyncHistoryEntryResponse": { "type": "object", "additionalProperties": false, "properties": { "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "recordsIngested": { "type": "integer", "format": "int32", "nullable": true }, "errorMessage": { "type": "string", "nullable": true } } }, "CostfluentPublicApiEndpointsV1ProvidersGetProviderSyncHistoryRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfProviderResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderResponse" } } } }, "CostfluentPublicApiEndpointsV1ProvidersListProvidersRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiModelsV1ResponsesConnectionTestResponse": { "type": "object", "additionalProperties": false, "required": [ "success" ], "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "nullable": true }, "metadata": { "type": "object", "nullable": true, "additionalProperties": {} } } }, "CostfluentPublicApiEndpointsV1ProvidersTestProviderConnectionRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesSyncTriggerResponse": { "type": "object", "additionalProperties": false, "required": [ "triggered" ], "properties": { "triggered": { "type": "boolean" }, "message": { "type": "string", "nullable": true } } }, "CostfluentPublicApiModelsV1RequestsTriggerProviderSyncRequest": { "type": "object", "additionalProperties": false, "properties": { "fullSync": { "type": "boolean" } } }, "CostfluentPublicApiModelsV1RequestsUpdateProviderRequest": { "type": "object", "additionalProperties": false, "properties": { "description": { "type": "string", "maxLength": 1000, "minLength": 0, "nullable": true }, "externalId": { "type": "string", "nullable": true }, "credentials": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "settings": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "syncFrequencyMinutes": { "type": "integer", "format": "int32", "maximum": 1440.0, "minimum": 60.0, "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesFolderCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "title": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsFolderPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateFolderRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "title" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "title": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "parentId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] } } }, "CostfluentPublicApiEndpointsV1FoldersDeleteFolderRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesFolderResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "title": { "type": "string" }, "parentId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] }, "reportCount": { "type": "integer", "format": "int32" }, "children": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderResponse" } } } }, "CostfluentPublicApiEndpointsV1FoldersGetFolderRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesFolderListResponse": { "type": "object", "additionalProperties": false, "required": [ "folders" ], "properties": { "folders": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderResponse" } } } }, "CostfluentPublicApiEndpointsV1FoldersListFoldersRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1RequestsUpdateFolderRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "title": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": true }, "parentId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] } } }, "CostfluentPublicApiModelsV1ResponsesAvailableCurrenciesResponse": { "type": "object", "additionalProperties": false, "required": [ "currencies" ], "properties": { "currencies": { "type": "array", "items": { "type": "string" } } } }, "CostfluentPublicApiModelsV1ResponsesExchangeRateResponse": { "type": "object", "additionalProperties": false, "required": [ "baseCurrency", "targetCurrency", "rate", "effectiveDate", "source" ], "properties": { "baseCurrency": { "type": "string" }, "targetCurrency": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "effectiveDate": { "type": "string", "format": "date" }, "source": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1ExchangeRatesGetExchangeRateRequest": { "type": "object", "additionalProperties": false }, "CostfluentFeaturesExchangeRatesResponsesFxPolicyStatusResponse": { "type": "object", "additionalProperties": false, "required": [ "available", "current", "history" ], "properties": { "available": { "type": "boolean" }, "current": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentFeaturesExchangeRatesResponsesFxPolicyResponse" } ] }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesExchangeRatesResponsesFxPolicyResponse" } } } }, "CostfluentFeaturesExchangeRatesResponsesFxPolicyResponse": { "type": "object", "additionalProperties": false, "required": [ "token", "method", "source", "presentationCurrency", "effectiveFrom", "effectiveToExclusive", "setAt", "isCurrent", "description" ], "properties": { "token": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFxPolicyPublicId" }, "method": { "$ref": "#/components/schemas/CostfluentDomainEnumsFxMethod" }, "source": { "type": "string" }, "presentationCurrency": { "type": "string" }, "effectiveFrom": { "type": "string", "format": "date" }, "effectiveToExclusive": { "type": "string", "format": "date", "nullable": true }, "setAt": { "type": "string", "format": "date-time" }, "isCurrent": { "type": "boolean" }, "description": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsFxPolicyPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentDomainEnumsFxMethod": { "type": "string", "description": "", "x-enumNames": [ "MonthEndRate", "MonthlyAverage", "TransactionDate" ], "enum": [ "monthEndRate", "monthlyAverage", "transactionDate" ] }, "CostfluentPublicApiEndpointsV1ExchangeRatesGetFxPolicyRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesExchangeRateListResponse": { "type": "object", "additionalProperties": false, "required": [ "rates", "total" ], "properties": { "rates": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesExchangeRateResponse" } }, "total": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiEndpointsV1ExchangeRatesListExchangeRatesRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesDashboardCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardPublicId" }, "title": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsDashboardPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateDashboardRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "title" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "title": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "isDefault": { "type": "boolean" }, "dateInterval": { "$ref": "#/components/schemas/CostfluentDomainEnumsDateInterval" }, "dateBin": { "$ref": "#/components/schemas/CostfluentDomainEnumsDateBin" } } }, "CostfluentDomainEnumsDateInterval": { "type": "string", "description": "", "x-enumNames": [ "ThisMonth", "LastMonth", "Last7Days", "Last30Days", "Last90Days", "YearToDate", "Custom", "ThisQuarter", "LastQuarter", "ThisYear", "LastYear" ], "enum": [ "thisMonth", "lastMonth", "last7Days", "last30Days", "last90Days", "yearToDate", "custom", "thisQuarter", "lastQuarter", "thisYear", "lastYear" ] }, "CostfluentDomainEnumsDateBin": { "type": "string", "description": "", "x-enumNames": [ "Day", "Week", "Month", "Quarter" ], "enum": [ "day", "week", "month", "quarter" ] }, "CostfluentPublicApiEndpointsV1DashboardsDeleteDashboardRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesDashboardResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title", "dateInterval", "dateBin", "widgets" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardPublicId" }, "title": { "type": "string" }, "isDefault": { "type": "boolean" }, "dateInterval": { "type": "string" }, "dateBin": { "type": "string" }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWidgetResponse" } }, "createdAt": { "type": "string", "format": "date-time" } } }, "CostfluentPublicApiModelsV1ResponsesWidgetResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "type", "title", "position" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDashboardWidgetPublicId" }, "type": { "type": "string" }, "title": { "type": "string" }, "position": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesWidgetPositionResponse" }, "config": { "type": "object", "nullable": true, "additionalProperties": {} } } }, "CostfluentSharedKernelPublicIdsDashboardWidgetPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesWidgetPositionResponse": { "type": "object", "additionalProperties": false, "properties": { "x": { "type": "integer", "format": "int32" }, "y": { "type": "integer", "format": "int32" }, "w": { "type": "integer", "format": "int32" }, "h": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiEndpointsV1DashboardsGetDashboardRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfDashboardResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesDashboardResponse" } } } }, "CostfluentPublicApiEndpointsV1DashboardsListDashboardsRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiEndpointsV1DashboardsUpdateDashboardRequest": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "nullable": true }, "dateInterval": { "type": "string", "nullable": true }, "dateBin": { "type": "string", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesSubmitCostsResponse": { "type": "object", "additionalProperties": false, "required": [ "uploadId", "totalRows", "acceptedRows", "rejectedRows" ], "properties": { "uploadId": { "type": "string" }, "totalRows": { "type": "integer", "format": "int32" }, "acceptedRows": { "type": "integer", "format": "int32" }, "rejectedRows": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostValidationError" } } } }, "CostfluentPublicApiModelsV1ResponsesCostValidationError": { "type": "object", "additionalProperties": false, "required": [ "rowIndex", "field", "message" ], "properties": { "rowIndex": { "type": "integer", "format": "int32" }, "field": { "type": "string" }, "message": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsSubmitCostsRequest": { "type": "object", "additionalProperties": false, "required": [ "costs" ], "properties": { "costs": { "type": "array", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCostEntry" } } } }, "CostfluentPublicApiModelsV1RequestsCostEntry": { "type": "object", "additionalProperties": false, "required": [ "chargePeriodStart", "chargeCategory", "serviceName", "billedCost" ], "properties": { "chargePeriodStart": { "type": "string" }, "chargeCategory": { "type": "string" }, "serviceName": { "type": "string" }, "billedCost": { "type": "number", "format": "double" }, "lineItemId": { "type": "string", "nullable": true }, "chargePeriodEnd": { "type": "string", "nullable": true }, "billingCurrency": { "type": "string", "nullable": true }, "serviceCategory": { "type": "string", "nullable": true }, "resourceId": { "type": "string", "nullable": true }, "resourceType": { "type": "string", "nullable": true }, "regionId": { "type": "string", "nullable": true }, "consumedQuantity": { "type": "number", "format": "double", "nullable": true }, "consumedUnit": { "type": "string", "nullable": true }, "tags": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "subAccountId": { "type": "string", "nullable": true }, "subAccountName": { "type": "string", "nullable": true }, "skuId": { "type": "string", "nullable": true }, "effectiveCost": { "type": "number", "format": "double", "nullable": true }, "chargeDescription": { "type": "string", "nullable": true }, "commitmentDiscountId": { "type": "string", "nullable": true }, "commitmentDiscountType": { "type": "string", "nullable": true } } }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsActivateCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false }, "CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "name": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "costReportId", "name", "scheduleType", "appIds" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "costReportId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "scheduleType": { "$ref": "#/components/schemas/CostfluentDomainEnumsScheduleType" }, "appIds": { "type": "array", "minLength": 1, "nullable": false, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAppPublicId" } } } }, "CostfluentSharedKernelPublicIdsCostReportPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentDomainEnumsScheduleType": { "type": "string", "description": "", "x-enumNames": [ "Daily", "Weekly", "Monthly" ], "enum": [ "daily", "weekly", "monthly" ] }, "CostfluentSharedKernelPublicIdsAppPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsDeactivateCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsDeleteCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "costReportId", "name", "scheduleType", "appIds" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportSubscriptionPublicId" }, "costReportId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "name": { "type": "string" }, "scheduleType": { "type": "string" }, "appIds": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAppPublicId" } }, "isActive": { "type": "boolean" }, "lastSentAt": { "type": "string", "format": "date-time", "nullable": true }, "nextScheduledAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsGetCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionListResponse": { "type": "object", "additionalProperties": false, "required": [ "subscriptions", "total" ], "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportSubscriptionResponse" } }, "total": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsListCostReportSubscriptionsRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostReportSubscriptionsUpdateCostReportSubscriptionRouteRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsUpdateCostReportSubscriptionRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiModelsV1RequestsUpdateCostReportSubscriptionRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": true }, "scheduleType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsScheduleType" } ] }, "appIds": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAppPublicId" } } } }, "CostfluentPublicApiModelsV1ResponsesCostReportCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "title": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateCostReportRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "title" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "title": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "folderId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] }, "filter": { "type": "string", "nullable": true }, "groupBy": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsCostGroupDimension" } ] }, "dateInterval": { "$ref": "#/components/schemas/CostfluentDomainEnumsDateInterval" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "chartType": { "$ref": "#/components/schemas/CostfluentDomainEnumsChartType" }, "dateBin": { "$ref": "#/components/schemas/CostfluentDomainEnumsDateBin" }, "settings": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCostReportSettingsRequest" } ] } } }, "CostfluentDomainEnumsCostGroupDimension": { "type": "string", "description": "", "x-enumNames": [ "Provider", "SubAccount", "ServiceName", "Region", "ResourceName", "ChargeCategory" ], "enum": [ "provider", "subAccount", "serviceName", "region", "resourceName", "chargeCategory" ] }, "CostfluentDomainEnumsChartType": { "type": "string", "description": "", "x-enumNames": [ "Line", "Bar", "StackedBar", "Area", "Pie", "Table" ], "enum": [ "line", "bar", "stackedBar", "area", "pie", "table" ] }, "CostfluentPublicApiModelsV1RequestsCostReportSettingsRequest": { "type": "object", "additionalProperties": false, "properties": { "includeCredits": { "type": "boolean" }, "includeRefunds": { "type": "boolean" }, "includeTax": { "type": "boolean" }, "amortize": { "type": "boolean" }, "showForecast": { "type": "boolean" }, "compareToLastPeriod": { "type": "boolean" } } }, "CostfluentPublicApiEndpointsV1CostReportsDeleteCostReportRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostReportDataResponse": { "type": "object", "additionalProperties": false, "required": [ "summary", "series", "breakdown" ], "properties": { "summary": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesReportSummaryResponse" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesReportTimeSeriesResponse" } }, "breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesReportBreakdownResponse" } }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "historyFloor": { "type": "string", "format": "date", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesReportSummaryResponse": { "type": "object", "additionalProperties": false, "required": [ "currency" ], "properties": { "totalCost": { "type": "number", "format": "double" }, "previousPeriodCost": { "type": "number", "format": "double", "nullable": true }, "changePercent": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesReportTimeSeriesResponse": { "type": "object", "additionalProperties": false, "required": [ "groups" ], "properties": { "date": { "type": "string", "format": "date" }, "groups": { "type": "object", "additionalProperties": { "type": "number", "format": "double" } } } }, "CostfluentPublicApiModelsV1ResponsesReportBreakdownResponse": { "type": "object", "additionalProperties": false, "required": [ "group" ], "properties": { "group": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" } } }, "CostfluentPublicApiEndpointsV1CostReportsGetCostReportDataRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostReportResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title", "dateInterval", "chartType", "dateBin", "settings" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostReportPublicId" }, "title": { "type": "string" }, "folderId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] }, "filter": { "type": "string", "nullable": true }, "groupBy": { "type": "string", "nullable": true }, "dateInterval": { "type": "string" }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "chartType": { "type": "string" }, "dateBin": { "type": "string" }, "settings": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportSettingsResponse" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesCostReportSettingsResponse": { "type": "object", "additionalProperties": false, "properties": { "includeCredits": { "type": "boolean" }, "includeRefunds": { "type": "boolean" }, "includeTax": { "type": "boolean" }, "amortize": { "type": "boolean" }, "showForecast": { "type": "boolean" }, "compareToLastPeriod": { "type": "boolean" } } }, "CostfluentPublicApiEndpointsV1CostReportsGetCostReportRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostReportListResponse": { "type": "object", "additionalProperties": false, "required": [ "reports", "folders", "total" ], "properties": { "reports": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostReportResponse" } }, "folders": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesFolderSummaryResponse" } }, "total": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiModelsV1ResponsesFolderSummaryResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "title" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" }, "title": { "type": "string" }, "reportCount": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiEndpointsV1CostReportsListCostReportsRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostReportsUpdateCostReportRequest": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string", "nullable": true }, "folderId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsFolderPublicId" } ] }, "filter": { "type": "string", "nullable": true }, "clearFilter": { "type": "boolean" }, "groupBy": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsCostGroupDimension" } ] }, "clearGroupBy": { "type": "boolean" }, "dateInterval": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsDateInterval" } ] }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "chartType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsChartType" } ] }, "dateBin": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsDateBin" } ] }, "settings": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsCostReportSettingsRequest" } ] } } }, "CostfluentPublicApiModelsV1ResponsesCostDataResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostDataPoint" } }, "meta": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostDataMeta" } } }, "CostfluentPublicApiModelsV1ResponsesCostDataPoint": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "format": "date" }, "cost": { "type": "number", "format": "double" }, "listCost": { "type": "number", "format": "double" }, "amortizedCost": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "dimensions": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CostfluentPublicApiModelsV1ResponsesCostDataMeta": { "type": "object", "additionalProperties": false, "properties": { "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" }, "granularity": { "type": "string" }, "totalRecords": { "type": "integer", "format": "int32" }, "totalCost": { "type": "number", "format": "double" }, "historyFloor": { "type": "string", "format": "date", "nullable": true } } }, "CostfluentPublicApiModelsV1RequestsGetCostDataRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostDataCostForecastResponse": { "type": "object", "additionalProperties": false, "properties": { "currentMonthActual": { "type": "number", "format": "double" }, "isAvailable": { "type": "boolean" }, "currentMonthForecast": { "type": "number", "format": "double", "nullable": true }, "method": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "confidencePercent": { "type": "number", "format": "double", "nullable": true }, "generatedAt": { "type": "string", "format": "date-time", "nullable": true }, "forecast": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiEndpointsV1CostDataForecastMonthResponse" } } } }, "CostfluentPublicApiEndpointsV1CostDataForecastMonthResponse": { "type": "object", "additionalProperties": false, "properties": { "month": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "lowerBound": { "type": "number", "format": "double" }, "upperBound": { "type": "number", "format": "double" } } }, "CostfluentPublicApiEndpointsV1CostDataGetCostForecastRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostSummaryResponse": { "type": "object", "additionalProperties": false, "properties": { "totalCost": { "type": "number", "format": "double" }, "totalListCost": { "type": "number", "format": "double" }, "totalAmortizedCost": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "costChange": { "type": "number", "format": "double" }, "costChangePercent": { "type": "number", "format": "double" }, "topServices": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesServiceCostBreakdown" } }, "byProvider": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesProviderCostBreakdown" } }, "historyFloor": { "type": "string", "format": "date", "nullable": true } } }, "CostfluentPublicApiModelsV1ResponsesServiceCostBreakdown": { "type": "object", "additionalProperties": false, "properties": { "serviceName": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "percentage": { "type": "number", "format": "double" } } }, "CostfluentPublicApiModelsV1ResponsesProviderCostBreakdown": { "type": "object", "additionalProperties": false, "required": [ "providerId" ], "properties": { "providerId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "providerName": { "type": "string" }, "providerKey": { "type": "string" }, "cost": { "type": "number", "format": "double" } } }, "CostfluentPublicApiModelsV1RequestsGetCostSummaryRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostAlertCreatedResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "name": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsCostAlertPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1RequestsCreateCostAlertRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "name", "thresholdType", "thresholdValue" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": false }, "thresholdType": { "$ref": "#/components/schemas/CostfluentDomainEnumsAlertThresholdType" }, "thresholdValue": { "type": "number", "format": "double", "minimum": 0.0, "exclusiveMinimum": true }, "comparisonPeriod": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsComparisonPeriod" } ] }, "providerIds": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" } }, "filter": { "type": "string", "nullable": true }, "appIds": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAppPublicId" } }, "evaluationFrequencyMinutes": { "type": "integer", "format": "int32", "maximum": 1440.0, "minimum": 15.0 } } }, "CostfluentDomainEnumsAlertThresholdType": { "type": "string", "description": "", "x-enumNames": [ "Absolute", "PercentageIncrease", "BudgetPercentage", "TagCoverageBelow" ], "enum": [ "absolute", "percentageIncrease", "budgetPercentage", "tagCoverageBelow" ] }, "CostfluentDomainEnumsComparisonPeriod": { "type": "string", "description": "", "x-enumNames": [ "PreviousDay", "PreviousWeek", "PreviousMonth", "SameDayLastMonth" ], "enum": [ "previousDay", "previousWeek", "previousMonth", "sameDayLastMonth" ] }, "CostfluentPublicApiEndpointsV1CostAlertsDeleteCostAlertRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostAlertResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "thresholdType", "appIds", "status" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertPublicId" }, "name": { "type": "string" }, "providerIds": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" } }, "filter": { "type": "string", "nullable": true }, "thresholdType": { "type": "string" }, "thresholdValue": { "type": "number", "format": "double" }, "comparisonPeriod": { "type": "string", "nullable": true }, "appIds": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAppPublicId" } }, "evaluationFrequencyMinutes": { "type": "integer", "format": "int32" }, "lastEvaluatedAt": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1CostAlertsGetCostAlertRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesCostAlertEventListResponse": { "type": "object", "additionalProperties": false, "required": [ "events", "total" ], "properties": { "events": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostAlertEventResponse" } }, "total": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiModelsV1ResponsesCostAlertEventResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "status" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsCostAlertEventPublicId" }, "triggeredAt": { "type": "string", "format": "date-time" }, "thresholdValue": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "comparisonValue": { "type": "number", "format": "double", "nullable": true }, "affectedProviderIds": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" } }, "status": { "type": "string" }, "acknowledgedByUserId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsUserPublicId" } ] }, "acknowledgedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentSharedKernelPublicIdsCostAlertEventPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentSharedKernelPublicIdsUserPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1CostAlertsGetCostAlertEventsRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfCostAlertResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesCostAlertResponse" } } } }, "CostfluentPublicApiEndpointsV1CostAlertsListCostAlertsRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiEndpointsV1CostAlertsPauseCostAlertRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostAlertsResumeCostAlertRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1CostAlertsUpdateCostAlertRouteRequest": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": true }, "thresholdType": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsAlertThresholdType" } ] }, "thresholdValue": { "type": "number", "format": "double", "minimum": 0.0, "nullable": true, "exclusiveMinimum": true }, "comparisonPeriod": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentDomainEnumsComparisonPeriod" } ] }, "providerIds": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } }, "filter": { "type": "string", "nullable": true }, "appIds": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } }, "evaluationFrequencyMinutes": { "type": "integer", "format": "int32", "maximum": 1440.0, "minimum": 15.0, "nullable": true } } }, "CostfluentFeaturesContractingResponsesDpaStatusResponse": { "type": "object", "additionalProperties": false, "required": [ "required", "inForce", "current", "history", "collectionRefusal" ], "properties": { "required": { "type": "boolean" }, "inForce": { "type": "boolean" }, "current": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentFeaturesContractingResponsesDpaExecutionResponse" } ] }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesContractingResponsesDpaExecutionResponse" } }, "collectionRefusal": { "type": "string", "nullable": true } } }, "CostfluentFeaturesContractingResponsesDpaExecutionResponse": { "type": "object", "additionalProperties": false, "required": [ "token", "documentVersion", "signedAt", "signedByName", "signedByRole", "recordedAt", "isCurrent", "supersededAt" ], "properties": { "token": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsDpaExecutionPublicId" }, "documentVersion": { "type": "string" }, "signedAt": { "type": "string", "format": "date" }, "signedByName": { "type": "string" }, "signedByRole": { "type": "string" }, "recordedAt": { "type": "string", "format": "date-time" }, "isCurrent": { "type": "boolean" }, "supersededAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentSharedKernelPublicIdsDpaExecutionPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesBudgetResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "spendAvailability" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsBudgetPublicId" }, "name": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "period": { "type": "string" }, "status": { "type": "string" }, "currentSpend": { "type": "number", "format": "double", "nullable": true }, "percentUsed": { "type": "number", "format": "double", "nullable": true }, "spendAvailability": { "type": "string" }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentSharedKernelPublicIdsBudgetPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesBudgetAlertResponse": { "type": "object", "additionalProperties": false, "properties": { "thresholdPercent": { "type": "integer", "format": "int32" }, "isTriggered": { "type": "boolean" }, "triggeredAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiModelsV1RequestsCreateBudgetRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "name", "currency" ], "properties": { "workspaceId": { "minLength": 1, "nullable": false, "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "amount": { "type": "number", "format": "double", "minimum": 0.0, "exclusiveMinimum": true }, "currency": { "type": "string", "maxLength": 3, "minLength": 3, "nullable": false }, "period": { "type": "string" }, "alerts": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1RequestsBudgetAlertRequest" } }, "segmentId": { "type": "string", "nullable": true } } }, "CostfluentPublicApiModelsV1RequestsBudgetAlertRequest": { "type": "object", "additionalProperties": false, "properties": { "thresholdPercent": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiEndpointsV1BudgetsDeleteBudgetRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1BudgetsGetBudgetRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1CommonPaginatedResponseOfBudgetResponse": { "type": "object", "additionalProperties": false, "required": [ "links", "data" ], "properties": { "links": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginationLinks" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesBudgetResponse" } } } }, "CostfluentPublicApiEndpointsV1BudgetsListBudgetsRequest": { "allOf": [ { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1CommonPaginatedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CostfluentPublicApiModelsV1RequestsUpdateBudgetRequest": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "segmentId": { "type": "string", "nullable": true } } }, "CostfluentFeaturesEntitlementsResponsesEntitlementResponse": { "type": "object", "additionalProperties": false, "properties": { "planCode": { "type": "string" }, "planName": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "spendCeiling": { "type": "number", "format": "double", "nullable": true }, "historyDays": { "type": "integer", "format": "int32", "nullable": true }, "maxConnections": { "type": "integer", "format": "int32", "nullable": true }, "maxAllocationRules": { "type": "integer", "format": "int32", "nullable": true }, "maxBackfillMonths": { "type": "integer", "format": "int32", "nullable": true }, "maxRowsPerMonth": { "type": "integer", "format": "int64", "nullable": true }, "maxBytesStored": { "type": "integer", "format": "int64", "nullable": true }, "features": { "type": "array", "items": { "type": "string" } }, "overriddenLimits": { "type": "array", "items": { "type": "string" } }, "ingestionHalted": { "type": "boolean" }, "ingestionHaltedReason": { "type": "string" }, "bandPlanCode": { "type": "string", "nullable": true }, "currentPeriodStart": { "type": "string", "format": "date" }, "currentPeriodEnd": { "type": "string", "format": "date" }, "ladder": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesEntitlementsResponsesPlanLadderEntryResponse" } } } }, "CostfluentFeaturesEntitlementsResponsesPlanLadderEntryResponse": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "priceAmount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "spendCeiling": { "type": "number", "format": "double", "nullable": true }, "historyDays": { "type": "integer", "format": "int32" }, "maxConnections": { "type": "integer", "format": "int32", "nullable": true }, "maxAllocationRules": { "type": "integer", "format": "int32", "nullable": true }, "features": { "type": "array", "items": { "type": "string" } }, "selfServeAvailable": { "type": "boolean" } } }, "CostfluentFeaturesEntitlementsResponsesUsageResponse": { "type": "object", "additionalProperties": false, "properties": { "periodStart": { "type": "string", "format": "date" }, "currency": { "type": "string" }, "trackedSpend": { "type": "number", "format": "double" }, "isSpendComplete": { "type": "boolean" }, "unconvertedCurrencies": { "type": "array", "items": { "type": "string" } }, "rowsIngested": { "type": "integer", "format": "int64" }, "bytesStored": { "type": "integer", "format": "int64" }, "connectionCount": { "type": "integer", "format": "int32" }, "activeUserCount": { "type": "integer", "format": "int32" }, "computedAt": { "type": "string", "format": "date-time", "nullable": true }, "averageTrackedSpend": { "type": "number", "format": "double", "nullable": true }, "bandPlanCode": { "type": "string", "nullable": true }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesEntitlementsResponsesUsageHistoryEntryResponse" } } } }, "CostfluentFeaturesEntitlementsResponsesUsageHistoryEntryResponse": { "type": "object", "additionalProperties": false, "properties": { "periodStart": { "type": "string", "format": "date" }, "trackedSpend": { "type": "number", "format": "double" }, "rowsIngested": { "type": "integer", "format": "int64" }, "bytesStored": { "type": "integer", "format": "int64" } } }, "CostfluentPublicApiEndpointsV1AnomaliesAcknowledgeAnomalyRequest": { "type": "object", "additionalProperties": false }, "CostfluentSharedKernelPublicIdsAnomalyPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiModelsV1ResponsesAnomalyListResponse": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAnomalyResponse" } }, "totalCount": { "type": "integer", "format": "int32" }, "unacknowledgedCount": { "type": "integer", "format": "int32" } } }, "CostfluentPublicApiModelsV1ResponsesAnomalyResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "providerId" ], "properties": { "id": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAnomalyPublicId" }, "providerId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsProviderPublicId" }, "anomalyDate": { "type": "string", "format": "date" }, "serviceName": { "type": "string" }, "region": { "type": "string", "nullable": true }, "anomalyType": { "type": "string" }, "severity": { "type": "string" }, "expectedCost": { "type": "number", "format": "double" }, "actualCost": { "type": "number", "format": "double" }, "deviationPercent": { "type": "number", "format": "double" }, "description": { "type": "string" }, "currency": { "type": "string" }, "isAcknowledged": { "type": "boolean" }, "acknowledgedAt": { "type": "string", "format": "date-time", "nullable": true }, "detectedAt": { "type": "string", "format": "date-time" } } }, "CostfluentPublicApiEndpointsV1AnomaliesListAnomaliesRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesAllocationRuleResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "priority", "matchField", "matchOperator", "matchValue", "costKind", "segmentId", "isEnabled", "createdAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "matchField": { "type": "string" }, "matchOperator": { "type": "string" }, "matchValue": { "type": "string" }, "matchTagKey": { "type": "string", "nullable": true }, "costKind": { "type": "string" }, "segmentId": { "type": "string" }, "segmentName": { "type": "string", "nullable": true }, "costCentre": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1AllocationListAllocationRulesRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1AllocationCreateAllocationRuleRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "name", "matchField", "matchOperator", "matchValue", "segmentId" ], "properties": { "workspaceId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "matchField": { "type": "string" }, "matchOperator": { "type": "string" }, "matchValue": { "type": "string" }, "matchTagKey": { "type": "string", "nullable": true }, "segmentId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSegmentPublicId" }, "isEnabled": { "type": "boolean" } } }, "CostfluentSharedKernelPublicIdsSegmentPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1AllocationUpdateAllocationRuleRequest": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "matchField": { "type": "string" }, "matchOperator": { "type": "string" }, "matchValue": { "type": "string" }, "matchTagKey": { "type": "string", "nullable": true }, "segmentId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSegmentPublicId" }, "isEnabled": { "type": "boolean" } } }, "CostfluentSharedKernelPublicIdsAllocationRulePublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1AllocationReorderAllocationRulesRequest": { "type": "object", "additionalProperties": false, "properties": { "workspaceId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "ruleIds": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsAllocationRulePublicId" } } } }, "CostfluentPublicApiEndpointsV1AllocationDeleteAllocationRuleRequest": { "type": "object", "additionalProperties": false }, "CostfluentFeaturesCostAllocationQueriesAllocationCoverageResponse": { "type": "object", "additionalProperties": false, "properties": { "windowStart": { "type": "string", "format": "date" }, "windowEndExclusive": { "type": "string", "format": "date" }, "costBasis": { "type": "string" }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesCostAllocationQueriesAllocationCoverageCurrency" } } } }, "CostfluentFeaturesCostAllocationQueriesAllocationCoverageCurrency": { "type": "object", "additionalProperties": false, "properties": { "billingCurrency": { "type": "string" }, "totalCost": { "type": "number", "format": "double" }, "directCost": { "type": "number", "format": "double" }, "sharedCost": { "type": "number", "format": "double" }, "undistributedSharedCost": { "type": "number", "format": "double" }, "unallocatedCost": { "type": "number", "format": "double" }, "unallocatedRecordCount": { "type": "integer", "format": "int64" }, "recordCount": { "type": "integer", "format": "int64" }, "coverage": { "type": "number", "format": "double", "nullable": true }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentFeaturesCostAllocationQueriesAllocationCoverageSegment" } } } }, "CostfluentFeaturesCostAllocationQueriesAllocationCoverageSegment": { "type": "object", "additionalProperties": false, "properties": { "segmentId": { "type": "string" }, "name": { "type": "string" }, "costCentre": { "type": "string" }, "directCost": { "type": "number", "format": "double" }, "sharedCost": { "type": "number", "format": "double" }, "allocatedCost": { "type": "number", "format": "double" }, "recordCount": { "type": "integer", "format": "int64" } } }, "CostfluentPublicApiEndpointsV1AllocationGetAllocationCoverageRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesSegmentResponse": { "type": "object", "additionalProperties": false, "required": [ "id", "teamLabel", "product", "costCentre", "isShared", "createdAt" ], "properties": { "id": { "type": "string" }, "teamId": { "type": "string", "nullable": true }, "teamLabel": { "type": "string" }, "teamName": { "type": "string", "nullable": true }, "product": { "type": "string" }, "costCentre": { "type": "string" }, "isShared": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } } }, "CostfluentPublicApiEndpointsV1AllocationListSegmentsRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiEndpointsV1AllocationCreateSegmentRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId" ], "properties": { "workspaceId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "teamId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsTeamPublicId" } ] }, "teamLabel": { "type": "string", "nullable": true }, "product": { "type": "string" }, "costCentre": { "type": "string" }, "isShared": { "type": "boolean" } } }, "CostfluentSharedKernelPublicIdsTeamPublicId": { "type": "object", "additionalProperties": false, "properties": { "Value": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1AllocationUpdateSegmentRequest": { "type": "object", "additionalProperties": false, "properties": { "teamId": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsTeamPublicId" } ] }, "teamLabel": { "type": "string", "nullable": true }, "product": { "type": "string" }, "costCentre": { "type": "string" } } }, "CostfluentPublicApiEndpointsV1AllocationDeleteSegmentRequest": { "type": "object", "additionalProperties": false }, "CostfluentPublicApiModelsV1ResponsesAllocationDryRunResponse": { "type": "object", "additionalProperties": false, "required": [ "billingCurrency", "movedCost", "movedRecordCount", "coverageBefore", "coverageAfter", "segmentChanges" ], "properties": { "billingCurrency": { "type": "string" }, "movedCost": { "type": "number", "format": "double" }, "movedRecordCount": { "type": "integer", "format": "int64" }, "coverageBefore": { "type": "number", "format": "double" }, "coverageAfter": { "type": "number", "format": "double" }, "segmentChanges": { "type": "array", "items": { "$ref": "#/components/schemas/CostfluentPublicApiModelsV1ResponsesAllocationDryRunSegmentChangeResponse" } } } }, "CostfluentPublicApiModelsV1ResponsesAllocationDryRunSegmentChangeResponse": { "type": "object", "additionalProperties": false, "required": [ "name", "costCentre", "allocatedBefore", "allocatedAfter", "delta" ], "properties": { "name": { "type": "string" }, "costCentre": { "type": "string" }, "allocatedBefore": { "type": "number", "format": "double" }, "allocatedAfter": { "type": "number", "format": "double" }, "delta": { "type": "number", "format": "double" } } }, "CostfluentPublicApiEndpointsV1AllocationPreviewAllocationRuleRequest": { "type": "object", "additionalProperties": false, "required": [ "workspaceId", "windowStart", "windowEndExclusive", "matchField", "matchOperator", "matchValue", "segmentId" ], "properties": { "workspaceId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsWorkspacePublicId" }, "windowStart": { "type": "string", "format": "date" }, "windowEndExclusive": { "type": "string", "format": "date" }, "matchField": { "type": "string" }, "matchOperator": { "type": "string" }, "matchValue": { "type": "string" }, "matchTagKey": { "type": "string", "nullable": true }, "segmentId": { "$ref": "#/components/schemas/CostfluentSharedKernelPublicIdsSegmentPublicId" }, "priority": { "type": "integer", "format": "int32" } } } }, "securitySchemes": { "ApiTokenAuth": { "type": "http", "description": "Costfluent API token beginning with cf_org_ or cf_ws_.", "scheme": "bearer", "bearerFormat": "API token" } } }, "security": [ { "ApiTokenAuth": [] } ] }