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

# Get service volume

> **Token scope:** `account` · `org` · `project` — read-only tokens allowed.

A compute or managed-database service's data volume (size + mount path — configurable on attachment for compute, the image's data directory for a managed DB; null when none is attached) plus this plan's volume cap.



## OpenAPI

````yaml /openapi/project.json get /projects/{projectId}/services/{serviceId}/volume
openapi: 3.1.0
info:
  title: InstaCloud API — Project level
  version: 0.1.0
  description: >-
    Endpoints under `/projects/{projectId}`: branches, services, deploys,
    secrets, databases, storage, cron, observability, governance. Callable with
    any token whose binding covers the project.


    Generated from the platform's own OpenAPI document
    (https://api.instacloud.com/openapi.json); see the [API
    overview](/reference/api/overview) for authentication and token scopes.
servers:
  - url: https://api.instacloud.com
    description: InstaCloud
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Projects inside an organization.
  - name: Branches
    description: >-
      Branch environments of a project: isolated database, storage and compute
      per branch.
  - name: Services
    description: 'Services on a branch: compute, postgres, storage and managed databases.'
  - name: Deploy
    description: Deploy an image or a source to a compute service.
  - name: Compute
    description: Build output of a compute service.
  - name: Secrets
    description: User secrets, service credentials and how they bind into compute env.
  - name: Database
    description: Postgres databases, extensions, credentials and ad-hoc SQL.
  - name: Storage
    description: Objects in a storage service.
  - name: Backups
    description: Database backups and restores.
  - name: Cron
    description: Scheduled HTTP calls against a service or an external URL.
  - name: Observability
    description: Logs, metrics, deploy events and database insight.
  - name: Governance
    description: Per-project agent policy and the approval queue.
  - name: Audit
    description: The project's event timeline, including agent-ingested events.
  - name: Domains
    description: >-
      Domains bought through InstaCloud, bring-your-own zones and their DNS
      records.
  - name: Billing
    description: Usage, cycles, invoices and credits.
  - name: Templates
    description: Deploy a template into a project.
paths:
  /projects/{projectId}/services/{serviceId}/volume:
    get:
      tags:
        - Services
      summary: Get service volume
      description: >-
        **Token scope:** `account` · `org` · `project` — read-only tokens
        allowed.


        A compute or managed-database service's data volume (size + mount path —
        configurable on attachment for compute, the image's data directory for a
        managed DB; null when none is attached) plus this plan's volume cap.
      operationId: getServiceVolume
      parameters:
        - schema:
            format: uuid
            type: string
          in: path
          name: projectId
          required: true
        - schema:
            format: uuid
            type: string
          in: path
          name: serviceId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  volume:
                    description: >-
                      null = no volume attached (attach one any time with PUT
                      …/volume)
                    anyOf:
                      - type: object
                        properties:
                          sizeGib:
                            type: integer
                          mountPath:
                            description: >-
                              configured container mount path (defaults to /data
                              for compute)
                            type: string
                          id:
                            anyOf:
                              - type: string
                              - type: 'null'
                          appliedMountPath:
                            anyOf:
                              - type: string
                              - type: 'null'
                          pending:
                            type: boolean
                        required:
                          - sizeGib
                          - mountPath
                      - type: 'null'
                  cap:
                    type: object
                    properties:
                      volumeGib:
                        description: this plan's maximum volume size (whole Gi)
                        type: integer
                    required:
                      - volumeGib
                required:
                  - volume
                  - cap
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session access JWT or an API token (`insta_<prefix>_<secret>`).

````