CLI: Admin

This page is auto-generated. Do not edit directly. To update, modify the CLI source in pinner-cli and run pnpm generate:clil.

`admin`

pinner admin

Administrative operations for quota management, billing, and profiling.

These commands require administrative privileges and are intended for system administrators.

Quota operations include:

List, create, update, delete quota plans
Manage user quota allowances
View system statistics
Reconcile quotas and cleanup expired data
Manage user quota configurations

Billing operations include:

Manage billing credits
View user balances
Manage price lines and pricing plans
Manage subscribers and subscriptions

Profiling operations include:

Access Go runtime pprof profiles (heap, cpu, goroutine, etc.)
Configure block and mutex profiling rates
View profiling status

 
pinner admin quota plans list
 
pinner admin quota allowances list
 
pinner admin billing credits list
 
pinner admin billing subscribers list
 
pinner admin pprof status
 
pinner admin pprof heap > heap.prof

Subcommands:

Subcommand	Description
`quota`	Manage quota plans, allowances, and user configurations.
`billing`	Manage billing credits, price lines, pricing plans, and subscriptions.
`websites`	Administrative operations for IPFS websites.
`pprof`	Access Go runtime profiling data via pprof endpoints.

`quota`

pinner admin quota

Manage quota plans, allowances, and user configurations.

Quota operations include:

Plan management (list, create, update, delete)
Allowance management (list, create, update, delete)
User config management
System statistics and reconciliation

 
pinner admin quota plans list
 
pinner admin quota plans get `<plan-id>`
 
pinner admin quota allowances list
 
pinner admin quota stats

Subcommands:

Subcommand	Description
`plans`	List, create, update, and delete quota plans.
`allowances`	List, create, update, and delete quota allowances.
`user-configs`	List and update user quota configurations.
`stats`	View quota system statistics.
`reconcile`	Reconcile quota data for all users or a specific user.
`cleanup`	Cleanup expired quota data older than the specified retention period.

`plans`

pinner admin quota plans

List, create, update, and delete quota plans.

 
pinner admin quota plans list
 
pinner admin quota plans get `<plan-id>`

Subcommands:

Subcommand	Description
`list`	List all available quota plans.
`get`	Get details of a specific quota plan.
`create`	Create a new quota plan with specified limits.
`update`	Update an existing quota plan.
`delete`	Delete a quota plan by ID.
`set-default`	Set a quota plan as the default for new users.

`list`

pinner admin quota plans list

List all available quota plans.

 
pinner admin quota plans list
 
pinner admin quota plans list --json

`get`

pinner admin quota plans get <plan-id>

Get details of a specific quota plan.

 
pinner admin quota plans get `<plan-id>`
 
pinner admin quota plans get `<plan-id>` --json

`create`

pinner admin quota plans create [flags]

Create a new quota plan with specified limits.

 
pinner admin quota plans create --name "Pro" --upload 1000 --download 2000 --storage 5000
 
pinner admin quota plans create --name "Free" --is-active --is-default
 
pinner admin quota plans create --name "Basic" --description "Basic tier" --is-active

Flag	Alias	Description
`--name`		Plan name
`--description`		Plan description
`--upload-limit`		Upload limit (bytes)
`--download-limit`		Download limit (bytes)
`--storage-limit`		Storage limit (bytes)
`--window-type`		Window type (ROLLING, DAY, WEEK, MONTH, YEAR, LIFETIME)
`--is-active`		Mark plan as active
`--is-default`		Set as default plan for new users

`update`

pinner admin quota plans update <plan-id> [flags]

Update an existing quota plan.

 
pinner admin quota plans update `<plan-id>` --name "Updated Pro"
 
pinner admin quota plans update `<plan-id>` --is-active --is-default

Flag	Alias	Description
`--name`		Plan name
`--description`		Plan description
`--upload-limit`		Upload limit (bytes)
`--download-limit`		Download limit (bytes)
`--storage-limit`		Storage limit (bytes)
`--window-type`		Window type (ROLLING, DAY, WEEK, MONTH, YEAR, LIFETIME)
`--is-active`		Mark plan as active
`--is-default`		Set as default plan for new users

`delete`

pinner admin quota plans delete <plan-id>

Delete a quota plan by ID.

 
pinner admin quota plans delete `<plan-id>`

`set-default`

pinner admin quota plans set-default <plan-id>

Set a quota plan as the default for new users.

 
pinner admin quota plans set-default `<plan-id>`

`allowances`

pinner admin quota allowances

List, create, update, and delete quota allowances.

 
pinner admin quota allowances list
 
pinner admin quota allowances create --user-id 123 --type bonus

Subcommands:

Subcommand	Description
`list`	List all quota allowances.
`create`	Create a new quota allowance for a user.
`update`	Update an existing quota allowance.
`delete`	Delete a quota allowance by grant ID.

`list`

pinner admin quota allowances list

List all quota allowances.

 
pinner admin quota allowances list
 
pinner admin quota allowances list --json

`create`

pinner admin quota allowances create [flags]

Create a new quota allowance for a user.

 
pinner admin quota allowances create --user-id 123 --source admin --type bonus --upload 1000

Flag	Alias	Description
`--user-id`		User ID
`--source`		Allowance source
`--quota-type`		Allowance type
`--upload-limit`		Upload allowance (bytes)
`--download-limit`		Download allowance (bytes)
`--storage-limit`		Storage allowance (bytes)
`--expiry`		Expiry in days from now

`update`

pinner admin quota allowances update <grant-id> [flags]

Update an existing quota allowance.

 
pinner admin quota allowances update `<grant-id>` --upload-limit 2000

Flag	Alias	Description
`--user-id`		User ID
`--source`		Allowance source
`--quota-type`		Allowance type
`--upload-limit`		Upload allowance (bytes)
`--download-limit`		Download allowance (bytes)
`--storage-limit`		Storage allowance (bytes)
`--expiry`		Expiry in days from now

`delete`

pinner admin quota allowances delete <grant-id>

Delete a quota allowance by grant ID.

 
pinner admin quota allowances delete `<grant-id>`

`user-configs`

pinner admin quota user-configs

List and update user quota configurations.

 
pinner admin quota user-configs list
 
pinner admin quota user-configs update --user-id 1 --plan-id 19
 
pinner admin quota user-configs reset `<user-id>`

Subcommands:

Subcommand	Description
`list`	List all user quota configurations.
`update`	Update a user's quota configuration.
`reset`	Reset a user's quota plan to the default.

`list`

pinner admin quota user-configs list

List all user quota configurations.

 
pinner admin quota user-configs list
 
pinner admin quota user-configs list --json

`update`

pinner admin quota user-configs update [flags]

Update a user's quota configuration.

 
pinner admin quota user-configs update --user-id 1 --plan-id 19
 
pinner admin quota user-configs update --user-id 1 --plan-id 19 --enforcement-policy HARD_LIMITS
 
pinner admin quota user-configs update --user-id 1 --upload-limit 5000 --download-limit 10000
 
pinner admin quota user-configs update --user-id 1 --plan-id 19 --json

Flag	Alias	Description
`--user-id`		User ID
`--plan-id`		Quota plan ID to assign
`--enforcement-policy`		Enforcement policy (HARD_LIMITS, UNLIMITED, ALLOWANCE, THRESHOLD)
`--upload-limit`		Upload limit override (bytes)
`--download-limit`		Download limit override (bytes)
`--storage-limit`		Storage limit override (bytes)
`--upload-threshold`		Upload threshold override (bytes)
`--download-threshold`		Download threshold override (bytes)
`--storage-threshold`		Storage threshold override (bytes)
`--window-duration`		Window duration override
`--window-start-hour`		Window start hour override
`--window-timezone`		Window timezone override
`--window-type`		Window type override (ROLLING, DAY, WEEK, MONTH, YEAR, LIFETIME)

`reset`

pinner admin quota user-configs reset <user-id>

Reset a user's quota plan to the default.

 
pinner admin quota user-configs reset `<user-id>`

`stats`

pinner admin quota stats

View quota system statistics.

 
pinner admin quota stats
 
pinner admin quota stats --json

`reconcile`

pinner admin quota reconcile [flags]

Reconcile quota data for all users or a specific user.

 
pinner admin quota reconcile
 
pinner admin quota reconcile --user-id 123

Flag	Alias	Description
`--user-id`		Specific user ID to reconcile (optional)

`cleanup`

pinner admin quota cleanup [flags]

Cleanup expired quota data older than the specified retention period.

 
pinner admin quota cleanup --retention-days 90

Flag	Alias	Description
`--retention-days`		Retention period in days

`billing`

pinner admin billing

Manage billing credits, price lines, pricing plans, and subscriptions.

Billing operations include:

Credit management (list, create, delete, restore, purge)
User balance viewing
Price line management
Pricing plan and period management
Subscriber and subscription management

 
pinner admin billing credits list
 
pinner admin billing price-lines list
 
pinner admin billing pricing-plans list
 
pinner admin billing subscribers list

Subcommands:

Subcommand	Description
`overview`	Display an overview of billing entities and their relationships.
`credits`	Manage billing credits for users.
`price-lines`	List, create, update, and delete billing price lines.
`pricing-plans`	List, create, update, delete, and sync billing pricing plans.
`pricing-plan-periods`	List, create, update, and delete billing pricing plan periods.
`subscribers`	List, manage, and modify billing subscribers.

`overview`

pinner admin billing overview

Display an overview of billing entities and their relationships.

Shows the data model hierarchy and current entity counts.

 
pinner admin billing overview
 
pinner admin billing overview --json

`credits`

pinner admin billing credits

Manage billing credits for users.

 
pinner admin billing credits list
 
pinner admin billing credits get `<id>`
 
pinner admin billing credits create --user-id 123 --amount 100.00 --type manual --direction credit
 
pinner admin billing credits delete `<id>`
 
pinner admin billing credits restore `<id>`
 
pinner admin billing credits purge
 
pinner admin billing credits user-balance `<user-id>`
 
pinner admin billing credits user-deleted-credits `<user-id>`

Subcommands:

Subcommand	Description
`list`	List all billing credits with optional filtering.
`get`	Get details of a specific credit by its ID.
`create`	Create a new billing credit for a user.
`delete`	Soft-delete a credit by its ID.
`restore`	Restore a soft-deleted credit by its ID.
`purge`	Permanently delete soft-deleted credits older than specified duration.
`user-balance`	Get the current balance for a specific user.
`user-deleted-credits`	Get all soft-deleted credits for a specific user.

`list`

pinner admin billing credits list [flags]

List all billing credits with optional filtering.

 
pinner admin billing credits list
 
pinner admin billing credits list --user-id 123
 
pinner admin billing credits list --direction credit
 
pinner admin billing credits list --type manual

Flag	Alias	Description
`--user-id`		Filter by user ID
`--direction`		Filter by direction (credit, debit)
`--type`		Filter by type

`get`

pinner admin billing credits get <id>

Get details of a specific credit by its ID.

 
pinner admin billing credits get `<id>`
 
pinner admin billing credits get `<id>` --json

`create`

pinner admin billing credits create [flags]

Create a new billing credit for a user.

 
pinner admin billing credits create --user-id 123 --amount 100.00 --type manual --direction credit
 
pinner admin billing credits create --user-id 123 --amount 50.00 --type promo --direction credit --description "Promotional credit"
 
pinner admin billing credits create --user-id 123 --amount 200.00 --type manual --direction debit --json

Flag	Alias	Description
`--user-id`		User ID to credit (required)
`--amount`		Credit amount (as decimal string) (required)
`--type`		Credit type (e.g., manual, promo, referral) (required)
`--direction`		Direction (credit or debit) (required)
`--description`		Credit description
`--reference-id`		Reference ID for this credit
`--reference-type`		Reference type for this credit

`delete`

pinner admin billing credits delete <id>

Soft-delete a credit by its ID.

 
pinner admin billing credits delete `<id>`
 
pinner admin billing credits delete `<id>` --json

`restore`

pinner admin billing credits restore <id>

Restore a soft-deleted credit by its ID.

 
pinner admin billing credits restore `<id>`
 
pinner admin billing credits restore `<id>` --json

`purge`

pinner admin billing credits purge [flags]

Permanently delete soft-deleted credits older than specified duration.

 
pinner admin billing credits purge
 
pinner admin billing credits purge --older-than "30d"
 
pinner admin billing credits purge --older-than "7d" --json

Flag	Alias	Description
`--older-than`		Delete credits deleted more than this duration ago (e.g., 30d, 1w, 24h)

`user-balance`

pinner admin billing credits user-balance <user-id>

Get the current balance for a specific user.

 
pinner admin billing credits user-balance `<user-id>`
 
pinner admin billing credits user-balance `<user-id>` --json

`user-deleted-credits`

pinner admin billing credits user-deleted-credits <user-id> [flags]

Get all soft-deleted credits for a specific user.

 
pinner admin billing credits user-deleted-credits `<user-id>`
 
pinner admin billing credits user-deleted-credits `<user-id>` --json

Flag	Alias	Description
`--direction`		Filter by direction
`--type`		Filter by type

`price-lines`

pinner admin billing price-lines

List, create, update, and delete billing price lines.

 
pinner admin billing price-lines list
 
pinner admin billing price-lines get `<id>`
 
pinner admin billing price-lines create --name "Storage" --description "Storage pricing"
 
pinner admin billing price-lines update `<id>` --name "Updated Storage"
 
pinner admin billing price-lines delete `<id>`
 
pinner admin billing price-lines add-plan `<id>` --plan-id `<plan-id>` --position 1
 
pinner admin billing price-lines delete-plan `<id>` --plan-id `<plan-id>`
 
pinner admin billing price-lines update-plan-position `<id>` --plan-id `<plan-id>` --position 2

Subcommands:

Subcommand	Description
`list`	List all billing price lines.
`get`	Get detailed information about a billing price line.
`create`	Create a new billing price line.
`update`	Update an existing price line.
`delete`	Delete a billing price line.
`add-plan`	Add a pricing plan to a price line.
`delete-plan`	Remove a pricing plan from a price line.
`update-plan-position`	Update the position of a pricing plan within a price line.

`list`

pinner admin billing price-lines list

List all billing price lines.

 
pinner admin billing price-lines list
 
pinner admin billing price-lines list --json

`get`

pinner admin billing price-lines get <id>

Get detailed information about a billing price line.

 
pinner admin billing price-lines get `<id>`
 
pinner admin billing price-lines get `<id>` --json

`create`

pinner admin billing price-lines create [flags]

Create a new billing price line.

 
pinner admin billing price-lines create --name "Storage" --description "Storage pricing"
 
pinner admin billing price-lines create --name "Bandwidth" --description "Monthly bandwidth" --json

Flag	Alias	Description
`--name`		Price line name (required)
`--description`		Price line description
`--is-active`		Mark price line as active
`--is-default`		Mark as default price line

`update`

pinner admin billing price-lines update <id> [flags]

Update an existing price line.

 
pinner admin billing price-lines update `<id>` --name "Updated Storage"
 
pinner admin billing price-lines update `<id>` --description "New description" --is-active false --json

Flag	Alias	Description
`--name`		Price line name
`--description`		Price line description
`--is-active`		Mark price line as active
`--is-default`		Mark as default price line

`delete`

pinner admin billing price-lines delete <id>

Delete a billing price line.

 
pinner admin billing price-lines delete `<id>`
 
pinner admin billing price-lines delete `<id>` --json

`add-plan`

pinner admin billing price-lines add-plan <id> [flags]

Add a pricing plan to a price line.

If --position is omitted, the plan is appended to the end of the price line.

 
pinner admin billing price-lines add-plan `<id>` --plan-id `<plan-id>`
 
pinner admin billing price-lines add-plan `<id>` --plan-id `<plan-id>` --position 1
 
pinner admin billing price-lines add-plan `<id>` --plan-id `<plan-id>` --json

Flag	Alias	Description
`--plan-id`		Pricing plan ID to add (required)
`--position`		Position of the plan in the price line (auto-appended if omitted)

`delete-plan`

pinner admin billing price-lines delete-plan <id> [flags]

Remove a pricing plan from a price line.

 
pinner admin billing price-lines delete-plan `<id>` --plan-id `<plan-id>`
 
pinner admin billing price-lines delete-plan `<id>` --plan-id `<plan-id>` --json

Flag	Alias	Description
`--plan-id`		Pricing plan ID to remove (required)

`update-plan-position`

pinner admin billing price-lines update-plan-position <id> [flags]

Update the position of a pricing plan within a price line.

 
pinner admin billing price-lines update-plan-position `<id>` --plan-id `<plan-id>` --position 1
 
pinner admin billing price-lines update-plan-position `<id>` --plan-id `<plan-id>` --position 2 --json

Flag	Alias	Description
`--plan-id`		Pricing plan ID to reposition (required)
`--position`		New position for the plan (required)

`pricing-plans`

pinner admin billing pricing-plans

List, create, update, delete, and sync billing pricing plans.

 
pinner admin billing pricing-plans list
 
pinner admin billing pricing-plans sync `<plan-id>`
 
pinner admin billing pricing-plans sync-all

Subcommands:

Subcommand	Description
`list`	List all billing pricing plans.
`get`	Get details of a specific pricing plan.
`create`	Create a new billing pricing plan.
`update`	Update an existing billing pricing plan.
`delete`	Delete a pricing plan by ID.
`sync`	Trigger immediate synchronization of a specific pricing plan with the payment gateway.
`sync-all`	Trigger synchronization of all pricing plans with payment gateways.

`list`

pinner admin billing pricing-plans list

List all billing pricing plans.

 
pinner admin billing pricing-plans list
 
pinner admin billing pricing-plans list --json

`get`

pinner admin billing pricing-plans get <plan-id>

Get details of a specific pricing plan.

Arguments:

<plan-id>

The unique identifier of the pricing plan

 
pinner admin billing pricing-plans get 1
 
pinner admin billing pricing-plans get 5 --json

`create`

pinner admin billing pricing-plans create [flags]

Create a new billing pricing plan.

Optionally create a pricing plan period in the same command by providing: --quota-plan-id: Creates a period with the specified quota plan --price: Required with --quota-plan-id, price in USD --cadence: Required with --quota-plan-id, cadence (monthly, yearly, rolling) --rolling-days: Optional, for rolling cadence only --allow-free: Optional, allows $0 price

 
pinner admin billing pricing-plans create --name "Pro Plan" --currency USD
 
pinner admin billing pricing-plans create --name "Basic" --currency USD --description "Basic plan" --is-active
 
pinner admin billing pricing-plans create --name "Premium" --currency USD --is-public --json
 
# Create plan with period in one command:
 
pinner admin billing pricing-plans create --name "Starter" --currency USD --quota-plan-id 1 --price 9.99 --cadence monthly
 
pinner admin billing pricing-plans create --name "Annual" --currency USD --quota-plan-id 2 --price 99.99 --cadence yearly

Flag	Alias	Description
`--name`		Pricing plan name (required)
`--currency`		Currency code (e.g., USD, EUR) (required)
`--description`		Plan description
`--is-active`		Mark plan as active
`--is-public`		Mark plan as public
`--priceline-id`		Associated price line ID
`--quota-plan-id`		Create a period: associated quota plan ID
`--price`		Create a period: price in USD
`--cadence`		Create a period: cadence (e.g., monthly, yearly, rolling)
`--rolling-days`		Create a period: rolling days (for rolling cadence only)
`--allow-free`		Create a period: allow $0 price

`update`

pinner admin billing pricing-plans update <id> [flags]

Update an existing billing pricing plan.

 
pinner admin billing pricing-plans update `<id>` --name "Updated Pro"
 
pinner admin billing pricing-plans update `<id>` --description "New desc" --is-active false --json

Flag	Alias	Description
`--name`		Pricing plan name
`--currency`		Currency code (e.g., USD, EUR)
`--description`		Plan description
`--is-active`		Mark plan as active
`--is-public`		Mark plan as public

`delete`

pinner admin billing pricing-plans delete <id>

Delete a pricing plan by ID.

 
pinner admin billing pricing-plans delete `<id>`
 
pinner admin billing pricing-plans delete `<id>` --json

`sync`

pinner admin billing pricing-plans sync <plan-id>

Trigger immediate synchronization of a specific pricing plan with the payment gateway.

This command syncs a single pricing plan to ensure the payment gateway has the latest configuration.

Arguments:

<plan-id>

The unique identifier of the pricing plan to sync

 
pinner admin billing pricing-plans sync `<plan-id>`
 
pinner admin billing pricing-plans sync 123 --json

`sync-all`

pinner admin billing pricing-plans sync-all

Trigger synchronization of all pricing plans with payment gateways.

This command syncs all pricing plans to ensure the payment gateways have the latest configurations.

 
pinner admin billing pricing-plans sync-all
 
pinner admin billing pricing-plans sync-all --json

`pricing-plan-periods`

pinner admin billing pricing-plan-periods

List, create, update, and delete billing pricing plan periods.

pinner admin billing pricing-plan-periods list

Subcommands:

Subcommand	Description
`list`	List all billing pricing plan periods.
`get`	Get details of a specific pricing plan period.
`create`	Create a new billing pricing plan period.
`update`	Update an existing billing pricing plan period.
`delete`	Delete a pricing plan period by ID.

`list`

pinner admin billing pricing-plan-periods list

List all billing pricing plan periods.

 
pinner admin billing pricing-plan-periods list
 
pinner admin billing pricing-plan-periods list --json

`get`

pinner admin billing pricing-plan-periods get <id>

Get details of a specific pricing plan period.

 
pinner admin billing pricing-plan-periods get `<id>`
 
pinner admin billing pricing-plan-periods get `<id>` --json

`create`

pinner admin billing pricing-plan-periods create [flags]

Create a new billing pricing plan period.

 
pinner admin billing pricing-plan-periods create --plan-id 123 --price 9.99 --cadence monthly --quota-plan-id 1
 
pinner admin billing pricing-plan-periods create --plan-id 123 --price 99.99 --cadence yearly --quota-plan-id 1 --json

Flag	Alias	Description
`--plan-id`		Pricing plan ID (required)
`--price`		Price in USD (required)
`--cadence`		Cadence (e.g., monthly, yearly) (required)
`--quota-plan-id`		Associated quota plan ID (required)
`--rolling-days`		Rolling days (for rolling periods)
`--allow-free`		Allow $0 price (free plan)

`update`

pinner admin billing pricing-plan-periods update <id> [flags]

Update an existing billing pricing plan period.

 
pinner admin billing pricing-plan-periods update `<id>` --price 19.99
 
pinner admin billing pricing-plan-periods update `<id>` --cadence yearly --json

Flag	Alias	Description
`--price`		Price in USD
`--cadence`		Cadence (e.g., monthly, yearly)
`--quota-plan-id`		Associated quota plan ID
`--rolling-days`		Rolling days (for rolling periods)
`--allow-free`		Allow $0 price (free plan)

`delete`

pinner admin billing pricing-plan-periods delete <id>

Delete a pricing plan period by ID.

 
pinner admin billing pricing-plan-periods delete `<id>`
 
pinner admin billing pricing-plan-periods delete `<id>` --json

`subscribers`

pinner admin billing subscribers

List, manage, and modify billing subscribers.

 
pinner admin billing subscribers list
 
pinner admin billing subscribers get `<id>`
 
pinner admin billing subscribers list-gateway `<gateway-id>`
 
pinner admin billing subscribers list-user `<user-id>`
 
pinner admin billing subscribers cancel --user-id 123
 
pinner admin billing subscribers abort-cancel --user-id 123
 
pinner admin billing subscribers change-plan --user-id 123 --plan-id "plan-abc"
 
pinner admin billing subscribers pause --user-id 123
 
pinner admin billing subscribers resume --user-id 123

Subcommands:

Subcommand	Description
`list`	List all billing subscribers across all gateways.
`get`	Get details of a specific subscriber.
`list-gateway`	List all subscribers for a specific gateway.
`list-user`	List all subscriptions for a specific user.
`cancel`	Cancel a user's subscription.
`abort-cancel`	Abort a scheduled subscription cancellation for a user.
`change-plan`	Change a user's subscription plan.
`pause`	Pause a user's subscription.
`resume`	Resume a paused subscription for a user.

`list`

pinner admin billing subscribers list

List all billing subscribers across all gateways.

 
pinner admin billing subscribers list
 
pinner admin billing subscribers list --json

`get`

pinner admin billing subscribers get <id>

Get details of a specific subscriber.

 
pinner admin billing subscribers get `<id>`
 
pinner admin billing subscribers get `<id>` --json

`list-gateway`

pinner admin billing subscribers list-gateway <gateway-id>

List all subscribers for a specific gateway.

 
pinner admin billing subscribers list-gateway `<gateway-id>`
 
pinner admin billing subscribers list-gateway `<gateway-id>` --json

`list-user`

pinner admin billing subscribers list-user <user-id>

List all subscriptions for a specific user.

 
pinner admin billing subscribers list-user `<user-id>`
 
pinner admin billing subscribers list-user `<user-id>` --json

`cancel`

pinner admin billing subscribers cancel [flags]

Cancel a user's subscription.

 
pinner admin billing subscribers cancel --user-id 123
 
pinner admin billing subscribers cancel --user-id 123 --mode immediate
 
pinner admin billing subscribers cancel --user-id 123 --json

Flag	Alias	Description
`--user-id`		User ID (required)
`--mode`		Cancel mode: immediate, end_of_billing_period, etc

`abort-cancel`

pinner admin billing subscribers abort-cancel [flags]

Abort a scheduled subscription cancellation for a user.

 
pinner admin billing subscribers abort-cancel --user-id 123
 
pinner admin billing subscribers abort-cancel --user-id 123 --json

Flag	Alias	Description
`--user-id`		User ID (required)

`change-plan`

pinner admin billing subscribers change-plan [flags]

Change a user's subscription plan.

 
pinner admin billing subscribers change-plan --user-id 123 --period-id 1
 
pinner admin billing subscribers change-plan --user-id 123 --period-id 1 --json

Flag	Alias	Description
`--user-id`		User ID (required)
`--period-id`		New plan period ID (required)

`pause`

pinner admin billing subscribers pause [flags]

Pause a user's subscription.

 
pinner admin billing subscribers pause --user-id 123
 
pinner admin billing subscribers pause --user-id 123 --json

Flag	Alias	Description
`--user-id`		User ID (required)

`resume`

pinner admin billing subscribers resume [flags]

Resume a paused subscription for a user.

 
pinner admin billing subscribers resume --user-id 123
 
pinner admin billing subscribers resume --user-id 123 --json

Flag	Alias	Description
`--user-id`		User ID (required)

`websites`

pinner admin websites

Administrative operations for IPFS websites.

 
pinner admin websites block `<website-id>`
 
pinner admin websites unblock `<website-id>`

Subcommands:

Subcommand	Description
`block`	Block a website by its ID.
`unblock`	Unblock a previously blocked website by its ID.

`block`

pinner admin websites block <website-id>

Block a website by its ID.

 
pinner admin websites block `<website-id>`
 
pinner admin websites block `<website-id>` --json

`unblock`

pinner admin websites unblock <website-id>

Unblock a previously blocked website by its ID.

 
pinner admin websites unblock `<website-id>`
 
pinner admin websites unblock `<website-id>` --json

`pprof`

pinner admin pprof

Access Go runtime profiling data via pprof endpoints.

Profiles are binary data meant for consumption by 'go tool pprof'. Redirect output to a file, then analyze:

pinner admin pprof heap > heap.prof && go tool pprof heap.prof

pinner admin pprof cpu > cpu.prof && go tool pprof cpu.prof

pinner admin pprof trace > trace.out && go tool trace trace.out

 
pinner admin pprof status
 
pinner admin pprof heap
 
pinner admin pprof set-block-rate 1
 
pinner admin pprof set-mutex-fraction 100

Subcommands:

Subcommand	Description
`index`	Show the pprof index page listing available profiles.
`block`	Get block profile data for analyzing goroutine blocking events.
`set-block-rate`	Set the block profiling rate. 0 disables, 1 captures all events, higher values sample.
`cmdline`	Get the command line of the running program.
`goroutine`	Get stack traces of all current goroutines.
`heap`	Get a sampling of memory allocations of live objects.
`mutex`	Get stack traces of holders of contended mutexes.
`set-mutex-fraction`	Set the mutex profiling fraction. 0 disables, 1 captures all events, 100 samples 1%.
`cpu`	Get a CPU profile for the default duration.
`status`	Get the current block and mutex profiling rates.
`symbol`	Look up program counters and return function names.
`threadcreate`	Get stack traces that led to the creation of new OS threads.
`trace`	Get an execution trace of the running program.

`index`

pinner admin pprof index

Show the pprof index page listing available profiles.

 
pinner admin pprof index

`block`

pinner admin pprof block

Get block profile data for analyzing goroutine blocking events.

 
pinner admin pprof block > block.prof && go tool pprof block.prof

`set-block-rate`

pinner admin pprof set-block-rate <rate>

Set the block profiling rate. 0 disables, 1 captures all events, higher values sample.

 
pinner admin pprof set-block-rate 1
 
pinner admin pprof set-block-rate 0

`cmdline`

pinner admin pprof cmdline

Get the command line of the running program.

 
pinner admin pprof cmdline

`goroutine`

pinner admin pprof goroutine

Get stack traces of all current goroutines.

 
pinner admin pprof goroutine > goroutine.prof && go tool pprof goroutine.prof

`heap`

pinner admin pprof heap

Get a sampling of memory allocations of live objects.

 
pinner admin pprof heap > heap.prof && go tool pprof heap.prof

`mutex`

pinner admin pprof mutex

Get stack traces of holders of contended mutexes.

 
pinner admin pprof mutex > mutex.prof && go tool pprof mutex.prof

`set-mutex-fraction`

pinner admin pprof set-mutex-fraction <fraction>

Set the mutex profiling fraction. 0 disables, 1 captures all events, 100 samples 1%.

 
pinner admin pprof set-mutex-fraction 1
 
pinner admin pprof set-mutex-fraction 0

`cpu`

pinner admin pprof cpu

Get a CPU profile for the default duration.

 
pinner admin pprof cpu > cpu.prof && go tool pprof cpu.prof

`status`

pinner admin pprof status

Get the current block and mutex profiling rates.

 
pinner admin pprof status
 
pinner admin pprof status --json

`symbol`

pinner admin pprof symbol

Look up program counters and return function names.

 
pinner admin pprof symbol

`threadcreate`

pinner admin pprof threadcreate

Get stack traces that led to the creation of new OS threads.

 
pinner admin pprof threadcreate > threadcreate.prof && go tool pprof threadcreate.prof

`trace`

pinner admin pprof trace

Get an execution trace of the running program.

 
pinner admin pprof trace > trace.out && go tool trace trace.out