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

# Get a volume sync

> Gets a volume sync.

<Warning>
  This endpoint is experimental and may change or be removed without notice.
</Warning>


## OpenAPI

````yaml get /v1/volumes/syncs/{volume_sync_id}
openapi: 3.1.0
info:
  description: REST API for management of Baseten resources
  title: Baseten management API
  version: 1.0.0
servers:
  - url: https://api.baseten.co
security:
  - BearerAuth: []
paths:
  /v1/volumes/syncs/{volume_sync_id}:
    parameters:
      - $ref: '#/components/parameters/volume_sync_id'
    get:
      summary: Gets a volume sync
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeSyncV1'
      x-codeSamples:
        - lang: bash
          source: |
            curl --request GET \
            --url https://api.baseten.co/v1/volumes/syncs/{volume_sync_id} \
            --header "Authorization: Bearer $BASETEN_API_KEY"
        - lang: python
          source: |-
            import requests
            import os
            API_KEY = os.environ.get("BASETEN_API_KEY", "<YOUR_API_KEY>")
            url = "https://api.baseten.co/v1/volumes/syncs/{volume_sync_id}"

            headers = {"Authorization": f"Bearer {API_KEY}"}

            response = requests.request(
                "GET",
                url,
                headers=headers,
                json={}
            )

            print(response.text)
components:
  parameters:
    volume_sync_id:
      schema:
        type: string
      name: volume_sync_id
      in: path
      required: true
  schemas:
    VolumeSyncV1:
      description: Current state and result of a volume sync.
      properties:
        sync_id:
          description: Identifier of this sync operation.
          title: Sync Id
          type: string
        status:
          $ref: '#/components/schemas/VolumeSyncStatusV1'
          description: Current lifecycle state of the sync.
        source:
          description: Remote source being synced.
          discriminator:
            mapping:
              AZURE:
                $ref: '#/components/schemas/VolumeSyncSourceAzureV1'
              BASETEN_TRAINING:
                $ref: '#/components/schemas/VolumeSyncSourceBasetenTrainingV1'
              COREWEAVE:
                $ref: '#/components/schemas/VolumeSyncSourceCoreWeaveV1'
              GCS:
                $ref: '#/components/schemas/VolumeSyncSourceGCSV1'
              HUGGING_FACE:
                $ref: '#/components/schemas/VolumeSyncSourceHuggingFaceV1'
              R2:
                $ref: '#/components/schemas/VolumeSyncSourceR2V1'
              S3:
                $ref: '#/components/schemas/VolumeSyncSourceS3V1'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/VolumeSyncSourceHuggingFaceV1'
            - $ref: '#/components/schemas/VolumeSyncSourceS3V1'
            - $ref: '#/components/schemas/VolumeSyncSourceGCSV1'
            - $ref: '#/components/schemas/VolumeSyncSourceAzureV1'
            - $ref: '#/components/schemas/VolumeSyncSourceR2V1'
            - $ref: '#/components/schemas/VolumeSyncSourceCoreWeaveV1'
            - $ref: '#/components/schemas/VolumeSyncSourceBasetenTrainingV1'
          title: Source
        destination:
          $ref: '#/components/schemas/VolumeSyncDestinationV1'
          description: BDN volume being populated.
        volume_version_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Produced artifact identifier; null until the sync is ready.
          title: Volume Version Id
        version_ref:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: Immutable BDN reference; null until the sync is ready.
          title: Version Ref
        content_digest:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: BLAKE3 digest of the synced content; null until available.
          title: Content Digest
        total_size_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Total size of the synced content in bytes; null until available.
          title: Total Size Bytes
        created_at:
          description: Time at which the sync was created.
          format: date-time
          title: Created At
          type: string
        completed_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          default: null
          description: Time at which the sync reached a terminal state.
          title: Completed At
        error:
          anyOf:
            - $ref: '#/components/schemas/VolumeSyncErrorV1'
            - type: 'null'
          default: null
          description: Redacted failure details; null unless the sync failed.
      required:
        - sync_id
        - status
        - source
        - destination
        - created_at
      title: VolumeSyncV1
      type: object
    VolumeSyncStatusV1:
      enum:
        - PENDING
        - SYNCING
        - READY
        - FAILED
        - CANCELED
      title: VolumeSyncStatusV1
      type: string
    VolumeSyncSourceAzureV1:
      additionalProperties: false
      description: Azure Blob Storage source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: AZURE
          description: Azure Blob Storage source type.
          title: Type
          type: string
      required:
        - uri
        - type
      title: VolumeSyncSourceAzureV1
      type: object
    VolumeSyncSourceBasetenTrainingV1:
      additionalProperties: false
      description: Baseten training artifact source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        type:
          const: BASETEN_TRAINING
          description: Baseten training artifact source type.
          title: Type
          type: string
      required:
        - uri
        - type
      title: VolumeSyncSourceBasetenTrainingV1
      type: object
    VolumeSyncSourceCoreWeaveV1:
      additionalProperties: false
      description: CoreWeave object storage source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: COREWEAVE
          description: CoreWeave object storage source type.
          title: Type
          type: string
      required:
        - uri
        - type
      title: VolumeSyncSourceCoreWeaveV1
      type: object
    VolumeSyncSourceGCSV1:
      additionalProperties: false
      description: Google Cloud Storage source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: GCS
          description: Google Cloud Storage source type.
          title: Type
          type: string
        gcp_oidc:
          anyOf:
            - $ref: '#/components/schemas/VolumeSyncAuthenticationGCPOIDCV1'
            - type: 'null'
          default: null
          description: >-
            GCP OIDC authentication for this source. Cannot be combined with
            auth_secret_name.
      required:
        - uri
        - type
      title: VolumeSyncSourceGCSV1
      type: object
    VolumeSyncSourceHuggingFaceV1:
      additionalProperties: false
      description: Hugging Face source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: HUGGING_FACE
          description: Hugging Face source type.
          title: Type
          type: string
      required:
        - uri
        - type
      title: VolumeSyncSourceHuggingFaceV1
      type: object
    VolumeSyncSourceR2V1:
      additionalProperties: false
      description: Cloudflare R2 source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: R2
          description: Cloudflare R2 source type.
          title: Type
          type: string
      required:
        - uri
        - type
      title: VolumeSyncSourceR2V1
      type: object
    VolumeSyncSourceS3V1:
      additionalProperties: false
      description: Amazon S3 source.
      properties:
        uri:
          description: Remote source URI to materialize into the destination volume.
          title: Uri
          type: string
        include:
          description: Glob patterns selecting files to include.
          items:
            type: string
          title: Include
          type: array
        exclude:
          description: Glob patterns selecting files to exclude.
          items:
            type: string
          title: Exclude
          type: array
        auth_secret_name:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          default: null
          description: Optional workspace secret containing credentials for this source.
          title: Auth Secret Name
        type:
          const: S3
          description: Amazon S3 source type.
          title: Type
          type: string
        aws_assume_role:
          anyOf:
            - $ref: '#/components/schemas/VolumeSyncAuthenticationAWSAssumeRoleV1'
            - type: 'null'
          default: null
          description: >-
            AWS AssumeRole authentication for this source. Cannot be combined
            with auth_secret_name.
        aws_oidc:
          anyOf:
            - $ref: '#/components/schemas/VolumeSyncAuthenticationAWSOIDCV1'
            - type: 'null'
          default: null
          description: >-
            AWS OIDC authentication for this source. Cannot be combined with
            other authentication fields.
      required:
        - uri
        - type
      title: VolumeSyncSourceS3V1
      type: object
    VolumeSyncDestinationV1:
      additionalProperties: false
      description: BDN destination for a volume sync.
      properties:
        ref:
          description: Destination as bdn:<namespace>/<volume> with an optional tag.
          title: Ref
          type: string
      required:
        - ref
      title: VolumeSyncDestinationV1
      type: object
    VolumeSyncErrorV1:
      description: Public failure details for a volume sync.
      properties:
        code:
          description: Stable machine-readable failure classification.
          title: Code
          type: string
        message:
          description: Redacted user-facing failure message.
          title: Message
          type: string
      required:
        - code
        - message
      title: VolumeSyncErrorV1
      type: object
    VolumeSyncAuthenticationGCPOIDCV1:
      additionalProperties: false
      description: Authentication using GCP Workload Identity Federation.
      properties:
        service_account:
          description: GCP service account to impersonate through OIDC.
          minLength: 1
          title: Service Account
          type: string
        workload_identity_provider:
          description: Full resource name of the GCP workload identity provider.
          minLength: 1
          title: Workload Identity Provider
          type: string
      required:
        - service_account
        - workload_identity_provider
      title: VolumeSyncAuthenticationGCPOIDCV1
      type: object
    VolumeSyncAuthenticationAWSAssumeRoleV1:
      additionalProperties: false
      description: Authentication using an AWS IAM role assumed by Baseten.
      properties:
        role_arn:
          description: AWS IAM role ARN to assume.
          minLength: 1
          title: Role Arn
          type: string
        region:
          description: AWS region for the assumed role session.
          minLength: 1
          title: Region
          type: string
      required:
        - role_arn
        - region
      title: VolumeSyncAuthenticationAWSAssumeRoleV1
      type: object
    VolumeSyncAuthenticationAWSOIDCV1:
      additionalProperties: false
      description: Authentication using an AWS IAM role and Baseten workload identity.
      properties:
        role_arn:
          description: AWS IAM role ARN to assume through OIDC.
          minLength: 1
          title: Role Arn
          type: string
        region:
          description: AWS region for the OIDC role session.
          minLength: 1
          title: Region
          type: string
      required:
        - role_arn
        - region
      title: VolumeSyncAuthenticationAWSOIDCV1
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send `Authorization: Bearer <api_key>`. The legacy `Authorization:
        Api-Key <api_key>` scheme is also accepted.

````