> ## Documentation Index > Fetch the complete documentation index at: https://docs.outerproduct.com/llms.txt > Use this file to discover all available pages before exploring further. # ListVolumes ## OpenAPI ````yaml /http-api-reference/openapi.json post /outerproduct.volume.v1.VolumeService/ListVolumes openapi: 3.1.0 info: title: OuterProduct Control Plane API description: >- Control-plane Connect RPCs over HTTP with ProtoJSON request and response bodies. version: v1alpha servers: - url: https://api.outerproduct.com security: - bearerAuth: [] tags: - name: ApiKey description: |- Manages the current user's application-owned personal access tokens. External sign-in is required; personal and execution tokens cannot manage keys. - name: BillingAccount description: >- How a workspace pays: its prepaid balance, topped up through the payment processor and spent by its usage. - name: Image description: >- The image registry: OCI distribution over its storage, whose formats are its own. The control plane serves it to users, admitting each only to their workspace's repository, and forwards to the OCI registry. Manifests and blobs are addressed by digest and never replaced; tags name manifests. - name: ImageBuilder description: >- Builds Images from image specs, and runs their install steps, each adding layers to its parent image, and package builds, each one pinned package's layer on its base, which install steps merge rather than install. The control plane serves `SubmitImageBuild` and `WaitImageBuild` to users, and forwards them to the scheduler's, which imports each image spec's base through the OCI registry, places each install step and package build on a node that builds, and tags the image it built in its workspace's repository. Those nodes serve the steps to the scheduler, by the scheduler's certificate, and run each in the sandbox the scheduler placed it in. - name: Policy description: >- Resource access policies evaluated by the application's Cedar authorizer. A policy belongs to the workspace of the credential that created it and governs only that workspace and what it owns; deployment-wide grants belong to the operator's policy. - name: Run description: >- Submits and observes product Runs, their Calls, and the Calls' Attempts. Every Run owns one rooted Call tree. - name: Secret - name: User description: / User crud service - name: Volume - name: Workspace description: >- The workspace a request's credential is bound to, and its members. A session starts bound to its user's workspace and may switch to another the user belongs to; an API key stays bound to the workspace it was created in. Requests act in the bound workspace. paths: /outerproduct.volume.v1.VolumeService/ListVolumes: post: tags: - Volume summary: ListVolumes operationId: outerproduct.volume.v1.VolumeService.ListVolumes parameters: - name: Connect-Protocol-Version in: header description: Define the version of the Connect protocol required: true schema: $ref: '#/components/schemas/connect-protocol-version' example: 1 - name: Connect-Timeout-Ms in: header description: Define the timeout, in ms schema: $ref: '#/components/schemas/connect-timeout-header' example: 1000 requestBody: content: application/json: schema: $ref: '#/components/schemas/outerproduct.volume.v1.ListVolumesRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/outerproduct.volume.v1.ListVolumesResponse default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' components: schemas: connect-protocol-version: type: number examples: - 1 title: Connect-Protocol-Version description: Define the version of the Connect protocol const: 1 connect-timeout-header: type: number examples: - 1000 title: Connect-Timeout-Ms description: Define the timeout, in ms outerproduct.volume.v1.ListVolumesRequest: type: object properties: pageSize: type: integer title: page_size format: int32 pageToken: type: string title: page_token names: type: array items: type: string title: names description: >- Match any listed resource name. Empty filters select all readable volumes. query: type: string title: query creators: type: array items: type: string title: creators order: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.VolumeOrder' title: order includeCreators: type: boolean title: include_creators description: Include distinct creators across all readable volumes. includePermissions: type: boolean title: include_permissions description: >- Include permission hints for the returned page; operations still authorize. title: ListVolumesRequest additionalProperties: false outerproduct.volume.v1.ListVolumesResponse: type: object properties: volumes: type: array items: $ref: '#/components/schemas/outerproduct.volume.v1.Volume' title: volumes nextPageToken: type: string title: next_page_token creators: type: array items: type: string title: creators manageableVolumes: type: array items: type: string title: manageable_volumes description: >- Names from this page the caller may manage, populated with include_permissions. title: ListVolumesResponse additionalProperties: false connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string 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. details: type: array items: $ref: '#/components/schemas/connect.error_details.Any' description: >- A list of messages that carry the error details. There is no limit on the number of messages. title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation outerproduct.volume.v1.VolumeOrder: type: string title: VolumeOrder enum: - VOLUME_ORDER_UNSPECIFIED - VOLUME_ORDER_NAME_ASCENDING - VOLUME_ORDER_CREATED_DESCENDING - VOLUME_ORDER_SIZE_ASCENDING - VOLUME_ORDER_SIZE_DESCENDING outerproduct.volume.v1.Volume: type: object anyOf: - type: object properties: azure: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.Azure' title: azure title: azure - type: object properties: gcs: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.Gcs' title: gcs title: gcs - type: object properties: outerproduct: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.OuterProduct' title: outerproduct title: outerproduct - type: object properties: s3: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.S3' title: s3 title: s3 unevaluatedProperties: false not: allOf: - anyOf: - required: - azure - required: - gcs - required: - outerproduct - required: - s3 - not: oneOf: - required: - azure - required: - gcs - required: - outerproduct - required: - s3 properties: name: type: string title: name description: 'Mutable name, unique in its workspace: volumes/{volume}.' uid: type: string title: uid description: Immutable UUID identity. description: type: string title: description created_by: type: - string - 'null' title: created_by updated_by: type: - string - 'null' title: updated_by created_at: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at updated_at: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at size_bytes: type: - string - 'null' title: size_bytes format: int64 workspace: type: string title: workspace description: >- The workspace that owns the Volume, its creating credential's; the name is unique in it. cf. Zitadel `resource_owner`; Modal volumes belong to a workspace. title: Volume connect.error_details.Any: type: object properties: type: type: string description: >- A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. value: type: string format: binary description: >- The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field. debug: type: object title: Debug additionalProperties: true description: >- Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic. additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details. outerproduct.volume.v1.Azure: type: object properties: account: type: string title: account container: type: string title: container prefix: type: string title: prefix credential: allOf: - $ref: >- #/components/schemas/outerproduct.secret.v1.AzureCredential.Reference title: credential description: >- Required for user-provided volumes; omitted for OuterProduct storage. title: Azure additionalProperties: false outerproduct.volume.v1.Gcs: type: object properties: bucket: type: string title: bucket prefix: type: string title: prefix credential: allOf: - $ref: >- #/components/schemas/outerproduct.secret.v1.GcpCredential.Reference title: credential description: |- optional string region = 4; ?? Required for user-provided volumes; omitted for OuterProduct storage. title: Gcs additionalProperties: false outerproduct.volume.v1.OuterProduct: type: object anyOf: - type: object properties: azure: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.Azure' title: azure title: azure - type: object properties: gcs: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.Gcs' title: gcs title: gcs - type: object properties: inMemory: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.InMemory' title: in_memory title: in_memory - type: object properties: localFilesystem: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.LocalFileSystem' title: local_filesystem title: local_filesystem - type: object properties: s3: allOf: - $ref: '#/components/schemas/outerproduct.volume.v1.S3' title: s3 title: s3 unevaluatedProperties: false not: allOf: - anyOf: - required: - azure - required: - gcs - required: - inMemory - required: - localFilesystem - required: - s3 - not: oneOf: - required: - azure - required: - gcs - required: - inMemory - required: - localFilesystem - required: - s3 properties: displayUri: type: string title: display_uri description: |- Human-readable storage location, schemes match that in the op.toml. Use provider for storage access. title: OuterProduct description: >- Storage allocated from the control plane's configured default object store. outerproduct.volume.v1.S3: type: object properties: bucket: type: string title: bucket prefix: type: string title: prefix region: type: string title: region endpoint: type: - string - 'null' title: endpoint format: uri credential: allOf: - $ref: >- #/components/schemas/outerproduct.secret.v1.AwsCredential.Reference title: credential description: >- Required for user-provided volumes; omitted for OuterProduct storage. title: S3 additionalProperties: false google.protobuf.Timestamp: type: string examples: - '2023-01-15T01:30:15.01Z' - '2024-12-25T12:00:00Z' format: date-time description: >- A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. outerproduct.secret.v1.AzureCredential.Reference: type: object properties: name: type: string title: name uid: type: string title: uid title: Reference additionalProperties: false description: References a Secret whose value is an Azure credential. outerproduct.secret.v1.GcpCredential.Reference: type: object properties: name: type: string title: name uid: type: string title: uid title: Reference additionalProperties: false description: References a Secret whose value is a GCP credential. outerproduct.volume.v1.InMemory: type: object title: InMemory additionalProperties: false outerproduct.volume.v1.LocalFileSystem: type: object properties: path: type: string title: path description: Volume directory on the control-plane host. title: LocalFileSystem additionalProperties: false outerproduct.secret.v1.AwsCredential.Reference: type: object properties: name: type: string title: name uid: type: string title: uid title: Reference additionalProperties: false description: References a Secret whose value is an AWS credential. securitySchemes: bearerAuth: type: http description: A user session token or personal API key. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.