> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update file system snapshot bucket config

> Set the organization's snapshot bucket. An empty bucket name reverts to CoreWeave-managed storage.



## OpenAPI

````yaml /openapi/sandboxes/openapi.yaml patch /v1/settings/fileSystemSnapshotBucketConfig
openapi: 3.0.3
info:
  title: CoreWeave Sandboxes API
  version: 0.0.1
  description: >-
    The Sandboxes API lets you manage runners, templates, volumes, network
    configurations, organization settings, and the lifecycle of individual
    sandboxes on CoreWeave.
servers:
  - url: https://api.cwsandbox.com
    description: >-
      CoreWeave sandbox data plane. Hosts the sandbox lifecycle, volumes,
      snapshots, runner discovery, and organization settings.
  - url: https://api.coreweave.com
    description: >-
      CoreWeave control plane. Hosts managed runner and sandbox template
      administration.
security:
  - bearerAuth: []
tags:
  - name: NetworkConfigService
    description: >-
      Create, get, list, update, and delete desired network configurations.
      Updating a configuration bound to a running sandbox changes its network
      rules without a restart. Requires API enablement and a runner with live
      network update support.
  - name: SandboxService
    description: >-
      Endpoints for the sandbox lifecycle: create (directly, from a template, or
      from a Compose file), get, list, exec, read and write files, snapshot,
      connect, purge, and delete.
  - name: DiscoveryService
    description: >-
      Read-only endpoints for discovering the runners visible to the caller's
      organization, with view, capability, and service-visibility filters.
      Runner IDs are unique only within an organization.
  - name: SettingsService
    description: >-
      Organization-level sandbox settings: the object-storage Workload Identity
      Federation (WIF) configuration, the file-system snapshot bucket
      configuration, Compose build storage, and secret stores.
  - name: VolumeService
    description: >-
      CRUD operations for organization-registered volumes that sandboxes can
      mount, plus the validation call that confirms a volume's backing source is
      usable.
  - name: RunnerManagementService
    description: >-
      CRUD operations for managed runners and the runner policy each one
      carries. Policy is a field on the runner, mutated through
      `CreateManagedRunner` and `UpdateManagedRunner`.
  - name: SandboxTemplateService
    description: >-
      CRUD operations for organization-scoped sandbox templates, the partial
      specs that `CreateSandboxFromTemplate` merges with per-request overrides.
paths:
  /v1/settings/fileSystemSnapshotBucketConfig:
    patch:
      tags:
        - SettingsService
      summary: Update file system snapshot bucket config
      description: >-
        UpdateFileSystemSnapshotBucketConfig sets the org's FSS bucket config.
        An
         empty bucket_name reverts the org to CoreWeave-managed.
      operationId: SettingsService_UpdateFileSystemSnapshotBucketConfig
      parameters:
        - name: updateMask
          in: query
          description: >-
            Comma-separated JSON paths to update. An omitted or empty mask
            replaces the whole configuration. The wildcard * is supported only
            over binary protobuf (gRPC or Connect protobuf), not JSON Connect or
            the REST updateMask query value.
          schema:
            type: string
            format: field-mask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/coreweave.sandbox.v1.FileSystemSnapshotBucketConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/coreweave.sandbox.v1.FileSystemSnapshotBucketConfig
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      servers:
        - url: https://api.cwsandbox.com
          description: CoreWeave sandbox data plane.
components:
  schemas:
    coreweave.sandbox.v1.FileSystemSnapshotBucketConfig:
      description: >-
        FileSystemSnapshotBucketConfig is the organization's FSS bucket
        configuration.
      type: object
      properties:
        bucketName:
          description: >-
            Bring-your-own bucket name. Empty means CoreWeave manages the
            bucket.
          type: string
        region:
          description: >-
            Object-store region for the bring-your-own bucket. Required iff
            bucket_name
             is set.
          type: string
        mode:
          description: >-
            Output-only ownership mode, derived by the server. An empty
            bucketName uses FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_CW_MANAGED; a
            configured bucket uses
            FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_BRING_YOUR_OWN.
            FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_UNSPECIFIED means the output mode
            is unset or unrecognized, not a default ownership mode. Do not use
            this field to select a mode in requests.
          type: string
          format: enum
          enum:
            - FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_UNSPECIFIED
            - FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_CW_MANAGED
            - FILE_SYSTEM_SNAPSHOT_BUCKET_MODE_BRING_YOUR_OWN
          readOnly: true
        effectiveBucketName:
          description: >-
            The bucket actually in effect: the customer bucket, or the
            CoreWeave-managed
             derived name.
          type: string
          readOnly: true
    google.rpc.Status:
      description: >-
        The `Status` type defines a logical error model that is suitable for
        different programming environments, including REST APIs and RPC APIs. It
        is used by [gRPC](https://github.com/grpc). Each `Status` message
        contains three pieces of data: error code, error message, and error
        details. You can find out more about this error model and how to work
        with it in the [API Design
        Guide](https://cloud.google.com/apis/design/errors).
      type: object
      properties:
        code:
          description: >-
            The status code, which should be an enum value of
            [google.rpc.Code][google.rpc.Code].
          type: integer
          format: int32
        message:
          description: >-
            A developer-facing error message, which should be in English. Any
            user-facing error message should be localized and sent in the
            [google.rpc.Status.details][google.rpc.Status.details] field, or
            localized by the client.
          type: string
        details:
          description: >-
            A list of messages that carry the error details.  There is a common
            set of message types for APIs to use.
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    google.protobuf.Any:
      description: >-
        Contains an arbitrary serialized message along with a @type that
        describes the type of the serialized message.
      type: object
      properties:
        '@type':
          description: The type of the serialized message.
          type: string
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: CoreWeave API access token sent as a bearer token.
      x-default: Bearer {API_ACCESS_TOKEN}

````