Skip to content
Sine Cloud
BoxOpenAPI

List Box resources

GET/api/box/v1

Lists Box resources the key can see in its organization and optional project scope. Cloud owns the directory, lifecycle and pagination; runtime fields come from the sine-box catalog when the private binding is configured and never trigger a provider call. Retired resources remain visible until removed, so filter on state.

Organization API key authentication

Authorization: Bearer $SINECLOUD_API_KEY

Required scopes: fileRead

Parameters

limit · query · Optional
Maximum resources per page.
cursor · query · Optional
Unmodified nextCursor from the previous page.

Responses

200
Box resource page.
400
Invalid fields, identity, path, cursor or query. Unknown/duplicate fields are rejected where validated.
401
Missing, invalid, expired or revoked organization credential.
403
Current issuer membership, product scope, project, resource lifecycle or entitlement denies access.
404
Resource, execution, snapshot, restore or file not found within the authorized organization.
409
State/identity conflict or unresolved execution. Observe the original durable identity; do not create replacement work to bypass uncertainty.
500
The request could not be completed. Preserve any durable identity before retrying.
503
Runtime, deployment or recovery evidence is unavailable. Read existing status before retrying an uncertain mutation.

Loading API reference…

Box · Setup & authentication

Base URLhttps://sinecloud.dev/api/box/v1/{boxId}

Open Console · Create an API key · Browse all APIs

Download API index

Before your first request

Select your organization, prepare resources in Console, and issue an organization API key with the required product scopes. Current permissions, resource access, budget and available funds are checked on every call.

Create and select a Box in Console. Replace boxId with the actual Box resource ID, never the parent activation ID. The catalog covers workspace files, directories, command execution, durable status, Sandbox runtime windows and retained backups. Lite commands need no VM start step. Sandbox commands require an explicitly confirmed and funded runtime window; idle allocated VM time is also billed. File access never starts a VM.

Grant the scopes documented on each operation, such as boxRun, fileRead or fileWrite. Creating a backup requires both boxRun and fileRead. Resource creation, restore initiation and backup deletion use Console sessions. Retain the original execution identity when recovering uncertain work.

Organization key authentication and base URL

The production API origin is https://sinecloud.dev; the documentation origin does not serve product requests. The path prefix is /api/box/v1/{boxId}. Use the complete path documented for the operation, replacing resource IDs, models and endpoint revisions with your actual selections.

Authorization: Bearer $SINECLOUD_API_KEY

Set SINECLOUD_API_KEY to your own environment variable value; never use platform service credentials. Each operation lists required scopes in x-sinecloud-scopes.

This reference is read-only. Run requests in Console or your own client. Browsing documentation never creates a key, starts execution or incurs an execution charge. Keep request IDs and execution receipts; a lost connection does not cancel work. Follow the operation’s recovery instructions before submitting again.

Sine CloudDocs
Console

Type to search…

↑↓ navigate↵ selectEsc Close