Sub2API Admin
Use the bundled CLI instead of ad hoc curl. Run examples from this skill directory.
export SUB2API_BASE_URL='https://your-sub2api-host'
export SUB2API_ADMIN_API_KEY='<admin api key>'
# Or, when the deployment uses admin JWT login instead of an admin API key:
# export SUB2API_JWT='<admin access_token>'
node scripts/sub2api-admin.js accounts list
For all commands and payload examples, read references/admin-cli.md.
Workflow
- Reuse
SUB2API_BASE_URLand eitherSUB2API_ADMIN_API_KEYorSUB2API_JWTfrom the environment. - Run read-only commands first:
accounts list,accounts get <id>,groups all, orproxies all. - Before destructive or bulk writes, print the target account names and IDs.
- Execute the write command only after the target set is clear.
- Run a follow-up read command to verify the result.
Common Commands
node scripts/sub2api-admin.js accounts list --page-size 20
node scripts/sub2api-admin.js accounts get 40
node scripts/sub2api-admin.js accounts usage 40
node scripts/sub2api-admin.js accounts set-schedulable 40 true
node scripts/sub2api-admin.js accounts bulk-update --ids 40,39 --json '{"concurrency":10}'
node scripts/sub2api-admin.js redeem-codes list --page-size 20
node scripts/sub2api-admin.js redeem-codes generate --json '{"count":1,"type":"balance","value":10}' --idempotency-key redeem-$(date +%s)
node scripts/sub2api-admin.js redeem-codes create-and-redeem --json '{"code":"order_123","type":"balance","value":10,"user_id":123}' --idempotency-key order-123
node scripts/sub2api-admin.js error-rules list
node scripts/sub2api-admin.js tls-profiles list
Safety Notes
- Authentication uses
x-api-keyfromSUB2API_ADMIN_API_KEYfirst, then falls back toAuthorization: Bearer <jwt>fromSUB2API_JWT. - If the API returns
INVALID_ADMIN_KEY, ask the user to regenerate the admin API key. If using JWT, log in as an admin user and copy theaccess_tokenfromPOST /api/v1/auth/login. accounts exportincludes credentials and tokens. Prefer--fileand avoid printing exports in chat.- Redeem code create/redeem commands should use
--idempotency-keyfor payment or recharge workflows. - For uncertain or newly added backend APIs, use
api <METHOD> <admin-path>after a read-only check.