JUMP TOCAST.AI API documentationAuthAPILoginpostLogin callbackgetCurrent login session infogetLogoutpostSAML flow callbackpostBillingAPISingle sign-on of ChargeBee portal.getRetrieves current user's subscription details.getCheckout current user's subscription.getAutoscalerAPIGet a Kubernetes agent install scriptgetGet karpenter definitions migration intentgetMigrate karpenter custom resource definitions to CAST AI configurationpostGet problematic workloadsgetGet rebalanced workloadsgetList cluster rebalancing plansgetGenerate a cluster rebalancing planpostGet a rebalancing plangetTrigger the rebalancing planpostGet cluster settingsgetGet cluster workloadsgetAuditAPIListAuditEntries returns audit entries for given cluster.getAuthTokenAPILists user auth tokens.getCreateAuthToken creates a new api auth token.postDeletes auth token.deleteRetrieves the specified auth token.getUpdates the specified auth token.postChatbotAPIGet a list of questions asked to the chatbot.getAsk a question to the chatbot.postProvide feedback for the question.postStart a new conversation with the chatbot. It must be called before asking any questions. You have to wait until the conversation returns READY status before asking questions.postWorkloadOptimizationAPI(ALPHA) Returns status of workload-autoscaler agent.get(ALPHA) Returns a list of workloads for the given cluster.get(ALPHA) Removes a workload from CAST AI. This does not delete the workload from the cluster.delete(ALPHA) Returns a workload by a given id.get(ALPHA) Updates a CAST AI managed workload.put(ALPHA) Returns workload-autoscaler installation command.get(ALPHA) Returns workload-autoscaler installation script.getComponentsAPIAccepts logs from CAST AI components running outside of the mother-ship.postAllocationGroupAPILists allocation groups.getCreates an allocation group for custom report.postGets allocation group summary for datatransfer costs.getGets cost allocation group summary.getGets workloads of datatransfer cost allocation group.getGets workloads of cost allocation group.getDeletes an allocation group.deleteUpdates an allocation group for custom report.putClusterReportAPIGets cluster cost report data.getGets cluster efficiency report data.getGets the available savings estimation report. Current cluster state is evaluated and a report is generated based on the workloads and nodes running in your cluster.getGets available savings history over time. Real cluster cost and estimated optimal cost.getGets cluster resource usage.getGets the rightsizing summary for the cluster.getGets cluster savings report.getGets current details about the cluster.getGets current details about all clusters of organization.getGets cost report data over all clusters of user organization.getGets unscheduled pods in the cluster.getWorkloadReportAPIGets workloads datatransfer costsgetGets workloads datatransfer costspostGets single workload cost report.getGets single workload cost report.getGets cluster workload efficiency report for a workload by name.getGets workload traffic destinations with their costs and history.getGets workload traffic destinations with their costs.getGets cluster workload efficiency report for the workloads.postGets cluster workloads cost report.getGets cluster workloads cost report.postGets cluster workload efficiency report.getGets cluster workload efficiency report.postGets the kubernetes labels applied to the workloads in the cluster.getGets the kubernetes label names applied to the workloads in the organization.postGets the kubernetes label values for the given label name.postReportConfigurationAPIGets workload grouping config.getUpserts workload grouping config.putReturns single command for external cluster with egressd installation script.getReturns egressd installation script template.getFeaturesAPIList all available feature flagspostResolve resolves a flag for the provided contextpostInventoryBlacklistAPIGet blacklist configurationgetAdd to blacklistpostRemove from blacklistpostUsersAPIGets all pending invitations in the organization.getCreate invitations to join organization by emailpostDelete an invitation by id.deleteConsume invitation and add current user to organizationpostGet profile for current user.getUpdate profile for current user.postList user organizations. If all arguments are empty, lists organizations for caller user. Organizations are sorted based on the date user joined the org, so first organization will always be the default one.getCreates an organization.postDelete an organization by id.deleteGet an organization by id.getEdit an organization by id.postGets all users which are members of the organization.getMakes the user a member of the organization.postRemoves the user from organization members.deleteUpdates user in the organization.putClusterActionsAPIPolls for pending cluster actions.getIngest cluster controller logs.postAck completed cluster action.postEvictorAPIGets evictor advanced configuration for the target cluster.getUpsert cluster's evictor advanced configuration.postNodeTemplatesAPIFilter instance typespostList node templatesgetCreate node templatepostDelete node templatedeleteUpdate node templateputNodeConfigurationAPILists cluster's node configurations.getCreates new node configuration for a specific cluster.postReturns suggested configuration for the clustergetDeletes node configuration of a specific cluster.deleteGet cluster's node configuration.getUpdates configuration of a specific cluster.postMarks node configuration as default.postPoliciesAPIGets all viable settings to be used for the Node Constraints feature.getGets policies configuration for the target cluster.getUpsert cluster's policies configuration.putScheduledRebalancingAPIList rebalancing jobsgetCreate rebalancing jobpostDelete rebalancing jobdeleteGet rebalancing jobgetUpdate rebalancing jobputPreview rebalancing schedulepostList rebalancing schedulesgetCreate rebalancing schedulepostEdit rebalancing scheduleputDelete rebalancing scheduledeleteGet rebalancing schedulegetList available rebalancing Time ZonesgetExternalClusterAPILists clusters for current user's organization.getRegisters new external cluster.postDeletes the cluster from CAST console. It won't delete the actual cluster from cloud provider's console.deleteGets the details of a specific cluster.getUpdates configuration of a specific cluster.postDelete AWS cross role user for assume role.deleteReturn AWS cross role user for assume role.getCreate AWS cross role user for assume role.postReturns AWS user arn used for assume role.getReturns single command for external cluster cleanup scriptgetReturns single command for external cluster credentials onboarding.getDisconnects cluster by removing all CAST dependencies from cloud provider's account.postHandles cloud spot interruption events for a cluster.postLists the nodes for a cluster.getAdds a node to the cluster.postDeletes the specified cluster node.deleteGets a single node by ID.getDrains the specified cluster node.postReconciles cluster.postReturns cluster token that is used for agent and cluster controller.postReturns cleanup script for the specified provider.getReturns credentials onboarding script for the specified provider.getOperationsAPIGetOperation returns the operation object by ID.getReportMetricsAPIReturns scrapable node-templates metrics in Prometheus format.getReturns scrapable workload metrics in Prometheus format.getNotificationAPIListNotifications returns notification entries for given organization.getAckNotifications acknowledges multiple notifications for the given organizationpostListWebhookConfig returns all available webhook categories and subcategoriesgetListWebhookConfig returns all existing webhook configurations for the given organizationgetCreateWebhookConfig creates a new webhook configuration for the given organizationpostDeleteWebhookConfig an existing webhook configurationdeleteGetWebhookConfig an existing webhook configuration for the given organizationgetUpdateWebhookConfig an existing webhook configuration for the given organizationputGetNotification returns an existing notification for the given organizationgetInventoryAPISync cluster resourcespostGet reservationsgetAdd or update reservationpostGet reservations balancegetOverwriteReservationspostDelete reservationdeleteGet organization used resourcesgetPartnersAPIList partner child organizations. Organizations are sorted based on the date organizations were created, so first organization will always be the latest.getCreate partner child organization.postReturns token to access partner child organization.postDeletes token which is used to access partner child organization.deleteUsageAPIGetUsageReport returns resource usage report.getGetUsageSummary returns resource usage summary for given period. If no parameters specified the summary will be calculated for previous 3 monthsgetCommitmentsAPIGet all assigned commitments to all clustersgetOne or multiple reservations can be selected and assigned/re-assigned to one or multiple clusterspostDelete cluster commitment for given clusterdeleteGet organization commitmentsgetImport commitmentspostDelete commitmentdeleteUpdate commitmentputInsightsAPIGet status of security agentspostGet attack paths list.getGet attack path details including graph.getGet latest best practices report.getGet resources for provided checks and filtering POST due to possible amount of parameterspostGet single check information and objects that matched the rule in the last best practices report.getEnforce linter rule as policy.postGet active exceptions for selected rulegetSend check exceptions.postGet a preview of resources that will be excepted with exception groupspostDelete policy enforcement.deleteRetrieve a list of possible filters for best practices report.getSchedule best practices scan for cluster.postGet latest best practices report summary.getGet checks that have not passed but are exceptedgetGet a list of container images for organizationgetSend a diff of changes (x exceptions added, y exceptions removed) for excepted imagespostGet a list of possible filters for images endpointgetGet container image vulnerability summary for organizationgetGet details for container image by taggetGet container image digests for organization by tag idgetGet a list of image packagesgetGet cluster resources for container imagegetGet a list of image vulnerabilitiesgetGet image vulnerability for a specific packagegetGet overview of best practices checks.getGet scans overview summary.getGet overview of vulnerability scan checks.getGet latest vulnerabilities report.getGet list of vulnerabilities for object.getGet list of resources for object.getGet list of vulnerabilities for packagegetGet list of vulnerable packages for object.getSchedule vulnerabilities scan for cluster.postGet latest vulnerabilities report summary.getGet status of security agentgetIngest log sent by Security AgentpostAgent calls this endpoint to sync state for scanned images.postAgent posts telemetry data to this endpoint.postSSOAPIList organization SSO connections.getCreate organization SSO connection.postDelete organization SSO connection.deleteGet organization SSO connection.getUpdate organization SSO connection.postMetricsAPI(BETA) Prometheus raw metrics.getGetUsageReport returns resource usage report.get https://api.cast.ai/v1/report/usage/daily
