Skip to main content
POST
List Storage Connections

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
next_cursor
string | null
after
string | null
include_total
boolean
default:false

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

Request payload for listing storage connections with filters.

Use this to filter connections by provider type, status, or active flag. Results are paginated automatically.

Use Cases:

  • List all active Google Drive connections
  • Find failed connections that need attention
  • Filter by provider type for sync configuration

Examples:

provider_type
enum<string> | null

OPTIONAL. Filter connections by provider type. Supported: google_drive, s3, snowflake, sharepoint, tigris. If not provided, returns connections of all types.

Available options:
google_drive,
s3,
snowflake,
sharepoint,
tigris,
postgresql,
instagram,
tiktok,
rss,
http_api,
box,
brightdata,
backblaze,
mux,
email,
supabase,
iconik,
gcs,
azure_blob,
rtsp
Example:

"google_drive"

status
enum<string> | null

OPTIONAL. Filter connections by operational status. ACTIVE: Healthy and ready for use. SUSPENDED: Temporarily disabled. FAILED: Health checks failing. ARCHIVED: Permanently retired.

Available options:
PENDING,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
INTERRUPTED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED,
DEACTIVATED
is_active
boolean | null

OPTIONAL. Filter by active flag. True: Returns only active connections (status=ACTIVE). False: Returns only inactive connections (SUSPENDED/FAILED/ARCHIVED). If not provided, returns connections of all active states.

Response

Successful Response

Response envelope for listing storage connections.

Contains paginated results and metadata about the listing operation.

results
StorageConnectionModel · object[]
required

List of storage connections matching the request filters. Results are paginated according to the pagination parameters. SECURITY: credential fields are not returned; only the credential type is.

pagination
PaginationResponse · object
required

Pagination metadata including total count, page number, page size, and navigation links for next/previous pages.

total
integer
required

Total number of connections matching the filters (before pagination). Use this to calculate total pages and display pagination controls.

Required range: x >= 0
Examples:

0

5

42