Skip to content

Management API

Automate access setup for your integration: create projects, invite teammates, assign roles and issue or revoke API/RPC keys within an existing workspace. Operations are limited by the management key's grants. Create the workspace and management key in the dashboard.

mgmt.vilna.io/v1 vilna_mgt_ · workspace REST · JSON Workspaces · projects · keys

Resource limits

Read workspace limits or project API key limits for current used counts and effective max values. Workspace fields are omitted when the key lacks permission to read the corresponding resource. Member usage includes unexpired pending invitations. API and RPC keys count until revoked, including expired keys.

A max of 0 prevents new creations; used can exceed a lowered maximum. These values are informational and do not reserve capacity.

What you can do

  • Activity log - review workspace and project events.
  • Members & invitations - invite teammates, set roles, and remove members.
  • Projects - create and manage isolated project environments.
  • Project members - assign teammates to specific projects with per-project roles.
  • API keys - create, list, read metadata and revoke project-scoped Platform API keys.
  • RPC keys - create, list, read metadata and revoke workspace-scoped RPC keys.

Management keys are viewed and managed in the dashboard using a user session. A management key cannot access those operations. See Management-key limits.

Resource hierarchy

Everything hangs off a workspace:

  • Workspace - the top-level unit, created in the dashboard.
    • Members & invitations - who has access to the workspace.
    • RPC keys and Management keys - workspace-scoped credentials.
    • Projects - isolated environments, each with its own addresses, transactions and keys.
      • API keys - project-scoped Platform API credentials.
      • Project members - per-project role assignments.

Key facts

  • Base URL - https://mgmt.vilna.io/v1; resources nest under /workspaces/{workspace_id}/.
  • Authentication - a vilna_mgt_ key in the X-Api-Key header; its fixed grants control access. See Permissions.
  • Format - JSON. A single item comes back as { "item": … }, a list as { "items": […], "meta": {…} } with ?limit=&page= pagination.
  • Errors - RFC 7807 problem+json.

Full endpoint reference: Management API reference.

Retrying mutations

Every POST, PATCH and DELETE requires an Idempotency-Key. Save one key and the request inputs for each intent, and reuse them after a lost response. See Idempotency for replay windows and recovery. Reconcile an uncertain outcome before deliberately starting another intent.