Jump to Content
Docs
API Reference
Release Notes
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Docs
API Reference
Release Notes
Assign commitment to a cluster
Search
JUMP TO
CAST.AI API documentation
AuthAPI
Login
post
Login callback
get
Current login session info
get
Logout
post
SAML flow callback
post
BillingAPI
Single sign-on of ChargeBee portal.
get
Retrieves current user's subscription details.
get
Checkout current user's subscription.
get
GetEnterpriseUsageReport returns enterprise resource usage report broken down per child organization.
get
GetSubscriptionDetails returns subscription details for the given organization.
get
GetUsageReport returns resource usage report.
get
AIEnablerAPI
GetCategorizedPrompts returns a list of categorized prompts from the AI Enabler.
get
UpdateCategorizedPrompt updates the categorized prompt.
put
Returns a savings report for the API keys used in chat completions.
get
Returns a recommendations report for the API keys used in chat completions.
get
Returns a report of chat completions usage data for a specific api key.
get
Returns a recommendations report for the category used in chat completions.
get
Returns a report of chat completions usage data for a specific category.
get
Returns a recommendations report of chat completions data.
get
Returns a report of chat completions usage data.
get
Returns a list of models available for routing.
get
GetRoutingEvents returns a list of routing events.
get
Returns a list of supported providers along with the supported models.
get
AIEnablerPlaygroundAPI
[Deprecated] Use /ai-optimizer/v1beta/organizations/{organization_id}/playground-chat-completions instead.
post
AIEnablerProvidersAPI
Gets the list of registered LLM providers.
get
Registers LLM providers.
post
Deletes LLM provider.
delete
Updates the registered LLM provider.
patch
Prioritizes registered LLM providers.
post
AIEnablerSettingsAPI
Returns the settings of the LLM Optimizer. If the apiKey query parameter is specified, fetches the settings for that apiKey. Otherwise, fetches the settings for the current organization. If there are no apiKey-specific settings, returns organization settings.
get
Updates the settings of the LLM Optimizer.
put
APAAPI
Get install command for APA agent.
get
Returns status of apa agent.
get
Returns the runbook configuration for the given runbook.
get
AuditAPI
ListAuditEntries returns audit entries for given cluster.
get
AuthTokenAPI
Lists user auth tokens.
get
CreateAuthToken creates a new api auth token.
post
Deletes auth token.
delete
Retrieves the specified auth token.
get
Updates the specified auth token.
post
AutoscalerAPI
Get a Kubernetes agent install script
get
Get karpenter definitions migration intent
get
Migrate karpenter custom resource definitions to CAST AI configuration
post
Get problematic nodes
get
Get problematic workloads
get
Get rebalanced workloads
get
List cluster rebalancing plans
get
Generate a cluster rebalancing plan
post
Get a rebalancing plan
get
Trigger the rebalancing plan
post
Get cluster settings
get
Get cluster workloads
get
ClusterActionsAPI
Polls for pending cluster actions.
get
Ingest cluster controller logs.
post
Ack completed cluster action.
post
ComponentsAPI
IngestLogs accepts logs from CAST AI components running outside of the mother-ship.
post
AllocationGroupAPI
Gets allocation group timed cost summaries.
get
Gets allocation group cost summaries.
get
Gets allocation groups timed total cost only.
get
Lists allocation groups.
get
Creates an allocation group for custom report.
post
Gets allocation group summary for datatransfer costs.
get
Gets allocation group efficiency summary.
get
Deprecated: use /v1/cost-reports/allocation-groups-summaries or /v1/cost-reports/allocation-group-costs.
get
Gets workloads of datatransfer cost allocation group.
get
Gets workloads of cost allocation group.
get
Gets allocation group efficiency workloads.
get
[Deprecated] Use /v1/cost-reports/allocation-groups/{group_id}/workload-costs instead.
get
Deletes an allocation group.
delete
Updates an allocation group for custom report.
put
ClusterReportAPI
Gets cluster cost report data.
get
Gets the all the detected cost anomalies for a cluster in a given time period.
get
Gets cluster efficiency report data.
get
Gets 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.
get
Gets available savings history over time. Real cluster cost and estimated optimal cost.
get
Gets cluster resource usage.
get
Gets the rightsizing summary for the cluster.
get
Gets cluster savings report.
get
Gets current details about the cluster.
get
Gets the efficiency summary per cluster for an organization.
get
Gets summary for all clusters for an organization
get
Gets current details about all clusters of organization.
get
Gets cost report data over all clusters of user organization.
get
Gets the efficiency per timestamp for an organization.
get
Gets the efficiency summary for an organization.
get
Get status of all castware components in the cluster.
get
Gets unscheduled pods in the cluster.
get
ReportConfigurationAPI
Gets workload grouping config.
get
Upserts workload grouping config.
put
Returns information about the report capabilities for a specific workload, e.g. if GPU is collected
get
Returns information about the report capabilities for a specific cluster, e.g. if GPU is collected
get
Returns single command for external cluster with egressd installation script.
get
Returns single command for external cluster with gpu-metrics-exporter installation script.
get
Returns egressd installation script template.
get
Returns gpu-metrics-exporter installation script template.
get
PlatformImpactReportAPI
Gets cost comparison report for two different periods. All clusters or selected.
get
NamespaceReportAPI
Gets cluster namespaces cost report summaries.
post
Gets cluster namespaces data transfer report
get
Gets a timed breakdown of the data transfer costs for the top K namespaces in the cluster (by default breakdown is by day).
get
Gets cluster namespaces cost report.
post
Gets a single namespace cost report with a daily breakdown.
get
NodeReportAPI
Gets the node templates report for a cluster.
get
Gets the kubernetes label names applied to the node in the organization.
post
Gets the kubernetes label values for the given label name.
post
ReportMetricsAPI
Returns scrapable allocation group metrics in Prometheus format.
get
Returns scrapable node-templates metrics in Prometheus format.
get
Returns scrapable workload metrics in Prometheus format.
get
Returns scrapable node metrics in Prometheus format.
get
Returns scrapable metrics in Prometheus format.
get
Returns scrapable workload network metrics in Prometheus format.
get
Returns scrapable workload metrics in Prometheus format.
get
WorkloadReportAPI
Gets workloads datatransfer costs
get
Gets workloads datatransfer costs
post
Gets single workload cost report.
get
Gets single workload cost report.
get
Gets cluster workload efficiency report for a workload by name.
get
Gets single workload GPU summary.
get
Gets workload traffic destinations with their costs and history.
get
Gets workload traffic destinations with their costs.
get
Gets cluster workload efficiency report for the workloads.
post
Gets cluster workloads compute cost report.
post
Gets cluster workloads cost report.
get
Gets cluster workloads cost report.
post
Gets cluster workload efficiency report.
get
Gets cluster workload efficiency report.
post
[Deprecated] Use `/v1/cost-reports/workload-labels/names` to get the label names and `/v1/cost-reports/workload-labels/values` to get the label values.
get
Gets the kubernetes namespaces for the given cluster IDs.
post
Gets the kubernetes label names applied to the workloads in the organization.
post
Gets the kubernetes label values for the given label name.
post
[Deprecated] Use `/v1/cost-reports/workload-labels/values` instead
post
Gets workloads GPU summary report.
post
Gets real time workloads GPU utilization %.
post
Gets workloads cost impact of wasted GPU resources report.
post
Gets the workloads metadata
post
DedicatedInstanceAPI
ListDedicatedInstances returns list of dedicated instances.
get
EvictorAPI
Gets evictor advanced configuration for the target cluster.
get
Upsert cluster's evictor advanced configuration.
post
ExternalClusterAPI
Lists clusters for current user's organization.
get
Registers new external cluster.
post
Returns list of available filters for nodes list.
get
Deletes the cluster from CAST console. It won't delete the actual cluster from cloud provider's console.
delete
Gets the details of a specific cluster.
get
Updates configuration of a specific cluster.
post
Delete AWS cross role user for assume role.
delete
Return AWS cross role user for assume role.
get
Create AWS cross role user for assume role.
post
Returns AWS user arn used for assume role.
get
Returns single command for external cluster cleanup script
get
Returns single command for external cluster credentials onboarding.
get
Disconnects cluster by removing all CAST dependencies from cloud provider's account.
post
Handles cloud spot interruption events for a cluster.
post
Create service account for GCP impersonation.
post
Disable service account and service key for impersonation.
post
Create service account and service key for GKE impersonation.
post
Create service account and service key for GKE impersonation.
post
Hiberantes cluster.
post
Lists the nodes for a cluster.
get
Adds a node to the cluster.
post
Deletes the specified cluster node.
delete
Gets a single node by ID.
get
Drains the specified cluster node.
post
Reconciles cluster.
post
Resumes cluster.
post
Updates tags of a specific cluster.
post
Returns cluster token that is used for agent and cluster controller.
post
Returns cleanup script for the specified provider.
get
Returns credentials onboarding script for the specified provider.
get
FeaturesAPI
List all available feature flags
get
Resolve resolves a flags for the provided context
post
InsightsAPI
Get status of security agents
post
Get attack paths list.
get
Get attack path details including graph.
get
Get latest best practices report.
get
Get resources for provided checks and filtering POST due to possible amount of parameters
post
Get single check information and objects that matched the rule in the last best practices report.
get
Enforce linter rule as policy.
post
Get active exceptions for selected rule
get
Send check exceptions.
post
Get check exceptions filters.
get
Get a preview of resources that will be excepted with exception groups
post
Get resources for provided check and filtering POST due to possible amount of parameters
post
Delete policy enforcement.
delete
Retrieve a list of possible filters for best practices report.
get
Schedule best practices scan for cluster.
post
Get all compliance standards supported for the organization
get
GetDailySummary returns the data of the daily vulnerability notification.
get
Get checks that have not passed but are excepted
get
Get a list of container images for organization
get
DeleteImages should be used for deleting old images
post
Send a diff of changes (x exceptions added, y exceptions removed) for excepted images
post
Get a list of possible filters for images endpoint
get
Get alternative images for public image
get
Get details for container image by tag
get
Get container image digests for organization by tag id
get
Get a list of image packages
get
Get cluster resources for container image
get
Get a list of image vulnerabilities
get
Get image vulnerability for a specific package
get
GetAttackPathsOverview returns a high-level overview of attack paths.
get
GetBestPracticesOverview returns a high-level overview of best practices.
get
GetImageSecurityOverview returns a high-level overview of image security.
get
GetManagedNodesOverview returns a high-level overview of managed nodes.
get
GetVulnerabilitiesOverview for the entire organization.
get
GetResourceDetails for display in attack path nodes
get
ListVulnerabilities across the entire organization.
get
FiltersForVulnerabilities are provided here.
get
ListWorkloads lists workloads in the organization
get
Get status of security agent
get
Ingest log sent by Security Agent
post
Agent calls this endpoint to sync state for scanned images.
post
Agent posts telemetry data to this endpoint.
post
Get list of integrations.
get
Create integration.
post
Delete integration.
delete
Get integration.
get
Update integration.
patch
GetProjects of the ticketing system setup through integrations.
get
CreateTicket in the ticketing system setup through integrations.
post
ListClusterSecuritySettings returns a list of clusters for the organization with their security settings.
get
GetClusterSecuritySettings returns security settings for a specific cluster.
get
ConfigureClusterSecuritySettings allows to configure security settings on a cluster.
post
InventoryBlacklistAPI
Get blacklist configuration
get
Add to blacklist
post
Remove from blacklist
post
CommitmentsAPI
Delete multiple commitments
post
Update multiple commitments. For commitments with auto-assignment enabled, it will additionally create missing matching assignments.
post
Get historical data on commitment usage. If commitmentId is "-", aggregated usage data for all commitments will be returned.
get
Get AWS commitments (reserved instances) import script
get
Get a template containing AWS commitment (reserved instances) import script
get
Import AWS commitments (reserved instances)
post
Get all commitments assignments
get
Assign commitment to a cluster
post
Remove commitment assignment
delete
Get commitments
get
Import Azure commitments (reservations)
post
Import GCP commitments (CUDs)
post
Get GCP commitments (CUDs) import script
get
Delete commitment
delete
Get commitment
get
Update commitment. If commitment auto-assignment is enabled, it will additionally create missing matching assignments.
put
Get commitment assignments
get
Replace commitment assignments. If commitment auto-assignment is enabled, it will generate and append matching assignments that are missing in the request.
put
Get a template containing GCP commitments (CUDs) import script
get
DiscountsAPI
List discounts
get
Create discount
post
Delete a given discount by its id
delete
Update a given discount
put
InventoryAPI
List all unique instance type names and families
get
[Deprecated] Use /v1/savings/commitments instead.
get
Get used resources for the currently authenticated organization
get
Sync cluster resources
post
[Deprecated] Use /v1/savings/commitments instead.
get
[Deprecated] Use /v1/savings/commitments/import/gcp/cud or /v1/savings/commitments/import/azure/reservation instead.
post
[Deprecated] Use /v1/savings/commitments instead.
get
[Deprecated] Use /v1/savings/commitments/import/gcp/cud or /v1/savings/commitments/import/azure/reservation instead.
post
[Deprecated] Use /v1/savings/commitments/{commitment_id} instead.
delete
List all regions
get
List all zones
get
PricingAPI
List hourly unit prices of CPU and memory for CAST Anywhere clusters in organization.
get
Get the hourly unit price for the CPU and memory of the CAST Anywhere cluster.
get
Upsert the hourly unit price for the CPU and memory of the CAST Anywhere cluster.
patch
Create the hourly unit price for the CPU and memory of the CAST Anywhere cluster.
post
Get pricing for cluster nodes by node ids or all nodes if ids are not provided
get
Get pricing for single cluster node
get
Get the pricing of organization nodes by ids or all nodes if ids are not provided
get
Sync GCP billing pricing API data
post
NodeConfigurationAPI
Lists cluster's node configurations.
get
Creates new node configuration for a specific cluster.
post
Returns suggested configuration for the cluster
get
Deletes node configuration of a specific cluster.
delete
Get cluster's node configuration.
get
Updates configuration of a specific cluster.
post
Marks node configuration as default.
post
Get list of presets available.
get
NodeTemplatesAPI
Filter instance types
post
Generate node templates
post
List node templates
get
Create node template
post
Delete node template
delete
Update node template
put
NotificationAPI
ListNotifications returns notification entries for given organization.
get
AckNotifications acknowledges multiple notifications for the given organization
post
ListWebhookConfig returns all available webhook categories and subcategories
get
ListWebhookConfig returns all existing webhook configurations for the given organization
get
CreateWebhookConfig creates a new webhook configuration for the given organization
post
DeleteWebhookConfig an existing webhook configuration
delete
GetWebhookConfig an existing webhook configuration for the given organization
get
UpdateWebhookConfig an existing webhook configuration for the given organization
put
GetNotification returns an existing notification for the given organization
get
OperationsAPI
GetOperation returns the operation object by ID.
get
PartnersAPI
List partner child organizations. Organizations are sorted based on the date organizations were created, so first organization will always be the latest.
get
Create partner child organization.
post
Returns token to access partner child organization.
post
Deletes token which is used to access partner child organization.
delete
PodMutationsAPI
List pod mutations
get
Create pod mutation
post
Get mutator status
get
Get install command for mutator
get
Get install script
get
Deletes pod mutation configuration
delete
Get pod mutations
get
Update pod mutation
put
PoliciesAPI
Gets all viable settings to be used for the Node Constraints feature.
get
Gets policies configuration for the target cluster.
get
Upsert cluster's policies configuration.
put
DboAPI
List onboarded cloud accounts.
get
Remove the onboarded cloud account.
delete
List cache groups.
get
Create cache group.
post
List cache configurations
get
Create cache configuration
post
Get cache efficiency data.
get
Get cache queries
get
List cache TTL configurations
get
Deletes TTL cache configuration
delete
Updates TTL cache configuration
put
Get cache summary
get
Deletes cache configuration
delete
Updates cache configuration
put
Create cache TTL configuration
post
Deletes cache group.
delete
Get cache group.
get
Update cache group.
put
Get cache group performance
get
State exchange
post
Get database cluster details
get
List database components
get
List database instances
get
Create database instance
post
Delete database instance
delete
Update database instance
put
Get database instance details
get
Get database instance cache performance
get
Get database instance infrastructure metrics
get
Delete logical database.
delete
Create logical databases.
post
Sends notification that someone filled in early access survey
post
Create new registration.
post
Returns shell script to execute a registration
get
Get registration status.
get
Create registration status update.
post
RbacServiceAPI
CreateGroup creates a group for the organization.
post
UpdateGroup updates the group for the organization.
patch
DeleteGroup deletes the group for the organization.
delete
GetGroup fetches a group for the organization.
get
ListRoleBindings lists the role bindings for the organization.
get
CreateRoleBindings creates role bindings for the organization.
post
DeleteRoleBinding deletes the role binding for the organization.
delete
GetRoleBinding fetches the role binding for the organization.
get
UpdateRoleBinding updates the role binding for the organization.
patch
ListRoles lists the roles for the organization.
get
RuntimeSecurityAPI
/v1/security/runtime/anomalies
get
/v1/security/runtime/anomalies/ack
post
/v1/security/runtime/anomalies/close
post
/v1/security/runtime/anomalies/{id}
get
/v1/security/runtime/anomalies/trigger-webhook
post
/v1/security/runtime/anomalies/{id}/events
get
/v1/security/runtime/anomalies/{id}/trigger-webhook
post
/v1/security/runtime/events
get
/v1/security/runtime/events/groups
get
/v1/security/runtime/events/process-tree/{clusterId}
get
/v1/security/runtime/list
get
/v1/security/runtime/list
post
/v1/security/runtime/list/delete
post
/v1/security/runtime/list/{id}
get
/v1/security/runtime/list/{id}/add
post
/v1/security/runtime/list/{id}/entries
get
/v1/security/runtime/list/{id}/remove
post
/v1/security/runtime/netflow/{clusterId}/graph
get
/v1/security/runtime/netflow/{clusterId}/list
get
/v1/security/runtime/netflow/{clusterId}/trend
get
GetAnomaliesOverview returns an overview of anomalies for all nodes and workloads.
get
/v1/security/runtime/rules
get
/v1/security/runtime/rules
post
/v1/security/runtime/rules/delete
post
/v1/security/runtime/rules/toggle
post
/v1/security/runtime/rules/validate
post
/v1/security/runtime/rules/{id}
get
/v1/security/runtime/rules/{id}
put
/v1/security/runtime/workloads-netflow/{clusterId}
get
ScheduledRebalancingAPI
List rebalancing jobs
get
Create rebalancing job
post
Delete rebalancing job
delete
Get rebalancing job
get
Update rebalancing job
put
Preview rebalancing schedule
post
List rebalancing schedules
get
Create rebalancing schedule
post
Edit rebalancing schedule
put
Delete rebalancing schedule
delete
Get rebalancing schedule
get
List available rebalancing Time Zones
get
ServiceAccountsAPI
DeleteServiceAccounts deletes a list of service accounts for the given organization.
delete
ListServiceAccounts lists all service accounts for organization in context.
get
CreateServiceAccount creates a service account for the given organization.
post
DeleteServiceAccount deletes a service account for the given organization.
delete
GetServiceAccount gets a service account for the given organization.
get
UpdateServiceAccount updates a service account for the given organization.
patch
CreateServiceAccountKey creates a service account key for the given organization.
post
UpdateServiceAccountKey updates a service account key for the given organization.
patch
DeleteServiceAccountKey deletes a service account key for the given organization.
delete
GetServiceAccountKey gets a service account key for the given organization.
get
SSOAPI
List organization SSO connections.
get
Create organization SSO connection.
post
Delete organization SSO connection.
delete
Get organization SSO connection.
get
Update organization SSO connection.
post
UsageAPI
[Deprecated] Use /v1/billing/usage-report instead.
get
[Deprecated] Use /v1/billing/usage-report instead.
get
UsersAPI
Gets all pending invitations in the organization.
get
Create invitations to join organization by email
post
Delete an invitation by id.
delete
Consume invitation and add current user to organization
post
Get profile for current user.
get
Update profile for current user.
post
List 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.
get
Creates an organization.
post
Delete an organization by id.
delete
Get an organization by id.
get
Edit an organization by id.
post
Removes users from organization members.
delete
Gets all users which are members of the organization.
get
Makes the user a member of the organization.
post
Removes the user from organization members.
delete
[Deprecated] use RbacServiceAPI for permission management instead.
put
Lists groups that a user is assigned to in the organization.
get
VulnerabilityFunnelAPI
GetVulnerabilitiesRecommendedActions returns data for the recommendations section.
get
GetVulnerabilitiesCounters returns data for the vulnerability funnel stages.
get
GetVulnerabilityDetails returns data for individual vulnerabilities.
get
WorkloadOptimizationAPI
Returns status of workload-autoscaler agent.
get
Returns a list of limit ranges for given cluster.
get
Returns a list of workload scaling policies for given cluster.
get
Creates a scaling policy that can be assigned to workloads at a later time.
post
Updates the order of scaling policies for a given cluster.
put
Deletes a scaling policy.
delete
Returns scaling policy.
get
Updates a scaling policy.
put
Assigns the provided list of workload IDs to the specified policy.
put
Returns a list of resource quotas for given cluster.
get
Returns a list of workload events for given cluster.
get
Returns a specific workload event by the given id.
get
Returns a list of workloads for the given cluster.
get
Returns workloads optimization summary.
get
Returns a workload by a given id.
get
Returns workload-autoscaler installation command.
get
Returns workload-autoscaler installation script.
get
Updates a CAST AI managed workload V2.
put
AI Enabler
ComponentsAPI
List CASTware components.
get
HostedModelSpecsAPI
List hosted model specs.
get
HostedModelsAPI
List hosted models.
get
Get hosted model pod statuses and events.
get
Delete hosted model deployment.
delete
Update hosted model.
patch
Scale the hosted model deployment.
post
Create hosted model.
post
OnboardingAPI
Get the onboarding command.
get
Get the onboarding script.
get
PlaygroundChatCompletionsAPI
Create playground chat completion.
post
SettingsAPI
List settings.
get
Get settings for an API key.
get
Create or update settings for an API key.
put
Delete setting for an API key.
delete
Get settings.
get
Update settings.
patch
Resolve settings.
get
SurveysAPI
Get survey status.
get
Update survey status.
patch
Patching Engine
PodMutationsAPI
List pod mutations.
get
Get a pod mutation.
get
Delete a pod mutation.
delete
Preview matched workloads.
post
Get the status of the pod mutator.
get
Get the pod mutator installation command.
get
Get the pod mutator installation script.
get
Create a pod mutation.
post
Update a pod mutation.
patch
Cluster Autoscaler
HibernationJobsAPI
Create cluster hibernation job.
post
Initiate manual cluster pause through a hibernation job.
post
Initiate manual cluster resume through a hibernation job.
post
HibernationSchedulesAPI
List hibernation schedules.
get
Create a hibernation schedule.
post
Get a hibernation schedule.
get
Delete a hibernation schedule.
delete
Update a hibernation schedule.
patch
Inventory
CloudAssetIntegrationsAPI
Lists cloud asset integrations.
get
Create a new cloud asset integration.
post
Delete a cloud asset integration.
delete
Update an existing cloud asset integration.
patch
Get the onboarding command for a cloud asset integration.
get
Get the onboarding script for a cloud asset integration.
get
Pricing
CommitmentsAPI
/pricing/v1beta/organizations/{organizationId}/commitments:getAzureReservationsImportCommand
get
/pricing/v1beta/organizations/{organizationId}/commitments:getAzureReservationsImportScript
get
/pricing/v1beta/organizations/{organizationId}/commitments:importAzureReservations
post
PricingAPI
Get default pricing for Cast Anywhere clusters.
get
Ask AI
Assign commitment to a cluster
post
https://api.cast.ai/v1/savings/assignments
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!
