Public API Documentation

VINEXELCLOUD / api docs

Cloud resource API

From configuration to deployment, billing and reconciliation.

Authentication and request lifecycle

Create a workspace key with cloud:read for infrastructure, cloud:write for operations, or cloud:billing:read for financial reads. Infrastructure keys do not gain billing access automatically. Keep it on your server. Every operation remains subject to membership, resource ownership, budget and activation checks.

Collections and results

Resource collections are paginated; the public catalog lists the currently published products. Read an operation by its ID after submission. A queued or confirmed command does not establish the final resource state. Infrastructure reads recheck current key scope, expiry, revocation and owner/admin membership under the workspace lock before returning records. Resource responses include observation.verified_at and refresh_required; retained instance data may predate the latest mutation. Resource lists contain at most 24 items and accept only a canonical positive page value. Invalid page values and unknown filters return 422.

Read credit activity

Billing access is limited to owners and administrators. Use GET /api/v1/cloud/billing/summary for available USD credit and all-time totals; use /api/v1/cloud/billing/transactions for posted activity with category, from, to and page filters. Dates use UTC. Read /transactions/{id} for whitelisted evidence and owned resource or invoice links. Reserves, usage, refunds and payment reversals remain separate entries. Filtered net change is not the available balance.

Safe retries

Keep the same request_key and payload when retrying. A changed payload with the same key returns a conflict. An indeterminate outcome requires reconciliation before another mutation. A successful refresh resolves start and stop only from their desired observed state, and termination only from a verified final contract. RUNNING alone cannot prove an uncertain reboot. Owners and administrators can record eligible power-outcome attestations with fresh provider evidence in the console; API keys cannot submit this review. Operation responses include only the safe resolution summary, keeping review notes and evidence references private.

Limits

Keys expire after 90 days. The API accepts at most 120 requests per key per minute and a 16 KB command body. Workspace quotas and spending admission apply separately.

Manage credentials ↗
GET /api/v1/cloud/resources
Authorization: Bearer <workspace-key>

POST /api/v1/cloud/operations
Authorization: Bearer <write-enabled-key>
Content-Type: application/json

{"action":"refresh","id":"<resource-id>","request_key":"<stable-key-at-least-16-chars>"}

GET /api/v1/cloud/operations/<operation-id>

401 invalid key; 403 role/scope; 404 owned record missing;
409 state/idempotency/quota conflict; 429 rate limit; 503 integration unavailable.