# CoreWeave Docs: Reference > Learn how to deploy, manage, and observe your AI training and inference workloads on CoreWeave. ## Reference - [Reference Home](https://docs.coreweave.com/reference-home.md): API references, Terraform resources, and technical specifications for CoreWeave products ### Reference Architectures #### Terraform reference architecture - [Terraform reference architecture](https://docs.coreweave.com/platform/reference-architecture.md): Deploy CoreWeave infrastructure as code with Terraform using a modular, two-phase approach - [1. Deploy core infrastructure](https://docs.coreweave.com/platform/reference-architecture/1-deploy-core-infrastructure.md): Create a CoreWeave VPC and CKS cluster with Terraform (Phase 1) - [2. Add Node Pools and Storage](https://docs.coreweave.com/platform/reference-architecture/2-add-storage-and-workloads.md): Add Node Pools and DFS volumes, and optionally Object Storage, to your CoreWeave Terraform deployment ### Terraform Provider - [CoreWeave Provider](https://docs.coreweave.com/platform/terraform.md): Manage CKS, VPC, Object Storage, and Managed Inference resources as code with Terraform #### Resources - [coreweave_cks_cluster (Resource)](https://docs.coreweave.com/platform/terraform/resources/cks_cluster.md): Terraform resource for creating and managing CoreWeave Kubernetes Service (CKS) clusters - [coreweave_inference_capacity_claim (Resource)](https://docs.coreweave.com/platform/terraform/resources/inference_capacity_claim.md): Terraform resource for creating and managing CoreWeave Managed Inference capacity claims - [coreweave_inference_deployment (Resource)](https://docs.coreweave.com/platform/terraform/resources/inference_deployment.md): Terraform resource for creating and managing CoreWeave Managed Inference deployments - [coreweave_inference_gateway (Resource)](https://docs.coreweave.com/platform/terraform/resources/inference_gateway.md): Terraform resource for creating and managing CoreWeave Managed Inference gateways - [coreweave_networking_vpc (Resource)](https://docs.coreweave.com/platform/terraform/resources/networking_vpc.md): Terraform resource for creating and managing CoreWeave VPCs with host prefixes and IPAM configuration - [coreweave_object_storage_bucket (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket.md): Terraform resource for creating CoreWeave Object Storage buckets with availability zone and tag configuration - [coreweave_object_storage_bucket_inventory (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket_inventory.md) - [coreweave_object_storage_bucket_lifecycle_configuration (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket_lifecycle_configuration.md): Terraform resource for configuring lifecycle rules on CoreWeave Object Storage buckets - [coreweave_object_storage_bucket_policy (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket_policy.md): Terraform resource for attaching S3-compatible access policies to CoreWeave Object Storage buckets - [coreweave_object_storage_bucket_settings (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket_settings.md): Terraform resource for managing CoreWeave Object Storage bucket settings such as audit logging - [coreweave_object_storage_bucket_versioning (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_bucket_versioning.md): Terraform resource for enabling or suspending versioning on CoreWeave Object Storage buckets - [coreweave_object_storage_organization_access_policy (Resource)](https://docs.coreweave.com/platform/terraform/resources/object_storage_organization_access_policy.md): Terraform resource for creating organization-wide access policies for CoreWeave Object Storage - [coreweave_workload_federation_oidc_config (Resource)](https://docs.coreweave.com/platform/terraform/resources/workload_federation_oidc_config.md) #### Data Sources - [coreweave_caller_identity (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/caller_identity.md): Terraform data source for the organization and principal IDs of the configured CoreWeave API token - [coreweave_cks_cluster (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/cks_cluster.md): Terraform data source for querying information about an existing CoreWeave CKS cluster by ID - [coreweave_inference_capacity_claim_parameters (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/inference_capacity_claim_parameters.md): Terraform data source for querying available Managed Inference capacity claim parameters - [coreweave_inference_deployment_parameters (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/inference_deployment_parameters.md): Terraform data source for querying available Managed Inference deployment parameters - [coreweave_inference_gateway_parameters (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/inference_gateway_parameters.md): Terraform data source for querying available Managed Inference gateway parameters - [coreweave_networking_vpc (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/networking_vpc.md): Terraform data source for querying information about an existing CoreWeave VPC by ID - [coreweave_object_storage_bucket_policy_document (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/object_storage_bucket_policy_document.md): Terraform data source for generating type-safe JSON bucket access policies for CoreWeave Object Storage - [coreweave_workload_federation_oidc_config (Data source)](https://docs.coreweave.com/platform/terraform/data-sources/workload_federation_oidc_config.md) ### CKS Reference - [Cluster components](https://docs.coreweave.com/products/cks/reference/cluster-components.md): Reference for the components within the CKS Managed Control Plane and Managed Data Plane - [Node Pool reference](https://docs.coreweave.com/products/cks/reference/node-pool.md): Complete API schema reference for CKS Node Pool resources, including spec fields and configuration options - [Request size limits](https://docs.coreweave.com/products/cks/reference/request-size-limits.md): Gateway and Kubernetes API request size limits that apply to all CoreWeave Kubernetes Service traffic #### CKS API - [CKS API](https://docs.coreweave.com/products/cks/reference/cks-api.md): REST and gRPC API for creating, listing, updating, and deleting CoreWeave CKS clusters. ##### ClusterService - [List clusters](https://docs.coreweave.com/products/cks/reference/cks-api/clusterservice/list-clusters.md): Fetch every CKS cluster the caller can read across all Availability Zones. - [Create cluster](https://docs.coreweave.com/products/cks/reference/cks-api/clusterservice/create-cluster.md): Create a new CoreWeave CKS cluster with optional OIDC, webhook, kubelet, and Tailscale configuration. - [Get cluster](https://docs.coreweave.com/products/cks/reference/cks-api/clusterservice/get-cluster.md): Fetch a single CoreWeave CKS cluster by its unique ID. - [Delete cluster](https://docs.coreweave.com/products/cks/reference/cks-api/clusterservice/delete-cluster.md): Delete a CoreWeave CKS cluster by its unique ID. - [Update cluster](https://docs.coreweave.com/products/cks/reference/cks-api/clusterservice/update-cluster.md): Update selected fields on a CoreWeave CKS cluster using a field mask. ### SUNK Reference - [Slurm images](https://docs.coreweave.com/products/sunk/reference/slurm-images.md): Reference for SUNK-built Slurm container images, including base and extras variants with supported CUDA versions - [SunkCluster CR](https://docs.coreweave.com/products/sunk/reference/sunkcluster-reference.md): Reference parameters for the SunkCluster custom resource that defines a managed SUNK cluster - [SUNK parameter reference](https://docs.coreweave.com/products/sunk/reference/sunk-parameters.md): Complete parameter reference for the SUNK operator Helm chart, including image, MySQL, and NVIDIA plugin settings - [Slurm parameter reference](https://docs.coreweave.com/products/sunk/reference/slurm-parameters.md): Complete parameter reference for the Slurm Helm chart, including accounting, compute, and deployment settings - [Slurm login parameter reference](https://docs.coreweave.com/products/sunk/reference/slurm-login-parameters.md): Complete parameter reference for the Slurm login Helm chart, including directory cache and affinity settings - [SCIM parameter reference](https://docs.coreweave.com/products/sunk/reference/nsscache_reference.md): Complete reference of configurable SCIM parameters for SUNK user identity management - [SUNK to Slurm version mapping](https://docs.coreweave.com/products/sunk/reference/sunk-slurm-versions.md): Mapping table between SUNK release versions and their corresponding Slurm versions ### Inference Reference #### Inference API - [Inference API reference](https://docs.coreweave.com/products/inference/reference/api-overview.md): Authentication, protocols, status values, and error formats for the CoreWeave Inference API ##### CapacityClaimService - [List capacity claims](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/list-capacity-claims.md): Fetch every CapacityClaim the caller can read, with optional `updatedAfter` filter. - [Create capacity claim](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/create-capacity-claim.md): Reserve GPU instances for inference deployments via a new CapacityClaim. - [Get capacity claim parameters](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/get-capacity-claim-parameters.md): Enumerate the available instance types per Availability Zone for CapacityClaim creation. - [Get capacity claim](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/get-capacity-claim.md): Fetch a single CapacityClaim by its UUID. - [Delete capacity claim](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/delete-capacity-claim.md): Delete a CoreWeave CapacityClaim by its UUID. - [Update capacity claim](https://docs.coreweave.com/products/inference/reference/api-overview/capacityclaimservice/update-capacity-claim.md): Update the resources reserved by a CapacityClaim. ##### DeploymentService - [List deployments](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/list-deployments.md): Fetch every deployment the caller can read, with optional gateway and `updatedAfter` filters. - [Create deployment](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/create-deployment.md): Create a new CoreWeave inference model deployment. - [Get deployment parameters](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/get-deployment-parameters.md): Enumerate the available gateways, runtime engines, and instance types for deployment creation. - [Get deployment](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/get-deployment.md): Fetch a single deployment by its ID. - [Delete deployment](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/delete-deployment.md): Delete a CoreWeave inference deployment by its ID. - [Update deployment](https://docs.coreweave.com/products/inference/reference/api-overview/deploymentservice/update-deployment.md): Update the spec of a CoreWeave inference deployment. ##### GatewayService - [List gateways](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/list-gateways.md): Fetch every inference gateway the caller can read, with optional `updatedAfter` filter. - [Create gateway](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/create-gateway.md): Create a CoreWeave inference gateway with one authentication type and one routing strategy. - [Get gateway parameters](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/get-gateway-parameters.md): Enumerate the available Availability Zones for gateway creation. - [Get gateway](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/get-gateway.md): Fetch a single inference gateway by its UUID. - [Delete gateway](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/delete-gateway.md): Delete a CoreWeave inference gateway by its UUID. - [Update gateway](https://docs.coreweave.com/products/inference/reference/api-overview/gatewayservice/update-gateway.md): Update the spec of a CoreWeave inference gateway. ### Object Storage Reference - [About Object Storage APIs](https://docs.coreweave.com/products/storage/object-storage/reference/about.md): Introduction to the S3-compatible API and the AI Object Storage API for identity and access management - [AI Object Storage S3 compatibility](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-s3.md): Supported S3-compatible features and calls for CoreWeave AI Object Storage #### AI Object Storage API - [AI Object Storage API](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref.md): Manage organization-wide access policies, bucket settings, and access keys ##### CWObject - [List access keys](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/list-access-keys.md): List access-key metadata for the caller's organization. - [Create access key](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/create-access-key.md): Create a permanent or time-limited access key from a CoreWeave Cloud token. - [Update access key status](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/update-access-key-status.md): Activate or suspend a principal's access keys. - [Get access key](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/get-access-key.md): Fetch metadata for a specific access key by ID. - [List access policies](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/list-access-policies.md): List every access policy defined for the caller's organization. - [Apply or update access policy](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/apply-or-update-access-policy.md): Create or update an access policy by name. - [Delete access policy](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/delete-access-policy.md): Delete an access policy by name. - [Check authorization](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/check-authorization.md): Check whether the caller is allowed to perform actions on resources. - [List bucket info](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/list-bucket-info.md): List inventory and usage for every bucket in the organization. - [Get bucket info](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/get-bucket-info.md): Fetch inventory and usage for a single bucket by name. - [Set bucket settings](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/set-bucket-settings.md): Configure non-S3 bucket settings such as audit logging. - [Set organization settings](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/set-organization-settings.md): Configure organization-wide AI Object Storage settings. - [Revoke an access key](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/revoke-an-access-key.md): Revoke a specific access key by its access-key value. - [Revoke a principal's access keys](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/revoke-a-principals-access-keys.md): Revoke every access key owned by a principal. - [Get v1cwobjecttemporary credentialsapi token](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/get-v1cwobjecttemporary-credentialsapi-token.md) - [Create access key from OIDC](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/create-access-key-from-oidc.md): Exchange an OIDC token for a temporary access key (anonymous on the CoreWeave side). - [Create access key from container credentials](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/create-access-key-from-container-credentials.md): Mint short-lived credentials for in-cluster workloads using the AWS container-credentials provider shape. - [Create access key from SAML](https://docs.coreweave.com/products/storage/object-storage/reference/object-storage-api-ref/cwobject/create-access-key-from-saml.md): Exchange a SAML assertion for a temporary access key (anonymous on the CoreWeave side). ### VPC Reference #### VPC API - [VPC API](https://docs.coreweave.com/products/networking/vpc/vpc-api.md): REST and gRPC API for creating, listing, updating, and deleting CoreWeave VPCs. ##### VPCService - [List VPCs](https://docs.coreweave.com/products/networking/vpc/vpc-api/vpcservice/list-vpcs.md): Fetch every VPC the caller can read across all Availability Zones. - [Create VPC](https://docs.coreweave.com/products/networking/vpc/vpc-api/vpcservice/create-vpc.md): Create a new CoreWeave VPC with optional host prefixes, VPC prefixes, and ingress/egress policy. - [Get VPC](https://docs.coreweave.com/products/networking/vpc/vpc-api/vpcservice/get-vpc.md): Fetch a single CoreWeave VPC by its unique ID. - [Delete VPC](https://docs.coreweave.com/products/networking/vpc/vpc-api/vpcservice/delete-vpc.md): Delete a CoreWeave VPC by its unique ID. - [Update VPC](https://docs.coreweave.com/products/networking/vpc/vpc-api/vpcservice/update-vpc.md): Update selected fields on a CoreWeave VPC using a field mask. ### Telemetry Relay Reference #### Telemetry Relay API - [Telemetry Relay API](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api.md): REST API for managing forwarding endpoints, pipelines, and telemetry streams for CoreWeave Telemetry Relay. ##### TelemetryRelayService - [List forwarding endpoints](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/list-forwarding-endpoints.md): Returns every forwarding endpoint in the caller's organization. Each endpoint is a destination that pipelines can target. Credentials are never returned in responses. - [Create forwarding endpoint](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/create-forwarding-endpoint.md): Creates a forwarding endpoint. The request body must include `ref.slug` (the unique per-organization identifier), `spec` (display name plus exactly one protocol-specific config), and the matching credentials block in the same oneof. Credentials are stored encrypted and never returned in responses. - [Get forwarding endpoint](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/get-forwarding-endpoint.md): Returns a single forwarding endpoint by its `ref.slug`, including the protocol-specific `spec` and current `status`. Credentials are never returned. - [Delete forwarding endpoint](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/delete-forwarding-endpoint.md): Deletes a forwarding endpoint identified by `ref.slug`. Delete any pipelines that target the endpoint first: if the endpoint is still referenced, the request is rejected with `412` (reason `TELEMETRYRELAY_ENDPOINT_IN_USE`) and the response lists the pipelines that must be deleted first. Returns `404… - [Update forwarding endpoint](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/update-forwarding-endpoint.md): Updates a forwarding endpoint identified by `ref.slug`. The request body must include the full `spec`. The endpoint's protocol type cannot change after creation. Use `credentialAction` to preserve, replace, or clear stored credentials. You can't clear credentials for AWS S3 destinations. - [Get forwarding endpoint status](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/get-forwarding-endpoint-status.md): Returns the last-known `ForwardingEndpointStatus` for a forwarding endpoint identified by `ref.slug`. This reads persisted state. It is not a live connectivity probe and does not verify TLS, authentication, or reachability against the destination. Live liveness checking is planned for a future relea… - [List forwarding pipelines](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/list-forwarding-pipelines.md): Returns every forwarding pipeline in the caller's organization. A pipeline binds a `source` stream to a `destination` endpoint and can be enabled or disabled independently. - [Create forwarding pipeline](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/create-forwarding-pipeline.md): Creates a forwarding pipeline. The request body must include `ref.slug` and a `spec` with the source stream's `slug`, the destination endpoint's `slug`, and `enabled` (true to start forwarding immediately). - [Get forwarding pipeline](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/get-forwarding-pipeline.md): Returns a single forwarding pipeline by its `ref.slug`, including the source/destination references and the current state. - [Delete forwarding pipeline](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/delete-forwarding-pipeline.md): Permanently deletes a forwarding pipeline identified by `ref.slug`. Forwarding stops immediately. Underlying endpoints and streams are not affected. Returns `404` (reason `TELEMETRYRELAY_PIPELINE_NOT_FOUND`) if no pipeline with that slug exists. - [Update forwarding pipeline](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/update-forwarding-pipeline.md): Updates a forwarding pipeline identified by `ref.slug`. The request body must include the full `spec` (source, destination, enabled). Use this to retarget a pipeline, enable or disable forwarding, or temporarily pause delivery. - [List telemetry streams](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/list-telemetry-streams.md): Returns every telemetry stream available to the caller's organization. Streams are pre-defined categories of platform telemetry (for example, audit logs) that can be forwarded by binding them to an endpoint via a pipeline. - [Get telemetry stream](https://docs.coreweave.com/observability/telemetry-forwarding/telemetry-relay-api/telemetryrelayservice/get-telemetry-stream.md): Returns a single telemetry stream by its `ref.slug`. Includes the stream's `spec` (display name, kind, label-selector filter) and `status` (current state and active zones). ### Mission Control MCP Reference - [Mission Control MCP tool reference](https://docs.coreweave.com/observability/mission-control-mcp/reference/tools.md): Every Mission Control MCP tool, grouped by family, with its inputs and outputs. ## OpenAPI Specs - [openapi](/openapi/cks/openapi.yaml) - [openapi](/openapi/inference/openapi.yaml) - [openapi](/openapi/storage/openapi.yaml) - [openapi](/openapi/vpc/openapi.yaml) - [openapi](/openapi/o11y/openapi.yaml)