Permission reference - ProxyScrape Docs

This page lists the permission identifiers you can assign to API keys. The full structure (including any account-specific variations) is available from GET /v4/account/api-keys/permission-context.

Product permissions (2-part: resource:action)

Permissions follow the form resource:action. Typical actions:

read — Read proxy lists, account/product info, and list resources.
write — Create or update resources (e.g. whitelist, settings).
delete — Revoke access, remove resources, or delete data.

Permission	Description
`datacenter_shared:read`	Read shared datacenter proxy list and account info.
`datacenter_shared:write`	Manage shared datacenter settings (e.g. whitelist).
`datacenter_shared:delete`	Revoke or remove shared datacenter access.
`datacenter_dedicated:read`	Read dedicated datacenter proxy list and account info.
`datacenter_dedicated:write`	Manage dedicated datacenter settings (e.g. whitelist).
`datacenter_dedicated:delete`	Revoke or remove dedicated datacenter access.
`residential:read`	Read residential proxy list and account info.
`residential:write`	Create, update, and reset password for residential subusers.
`residential:delete`	Revoke or remove residential access.
`residential_unlimited:read`	Read residential_unlimited proxy list and account info.
`residential_unlimited:write`	Manage residential_unlimited settings (e.g. whitelist).
`residential_unlimited:delete`	Revoke or remove residential_unlimited access. Not used by any Account API endpoint currently.
`serp_api:read`	Read SERP API usage and account info.
`serp_api:write`	Manage SERP API settings.
`serp_api:delete`	Revoke or remove SERP API access.

The permission-context endpoint returns the full set of permissions available for your account.

Subaccount permissions

Permission	Description
`subaccount:read`	List subaccounts, get preferences, countries available.
`subaccount:write`	Update subaccount preferences.

Account API key permissions (3-part: account:apikeys:action)

These permissions control API key management for the account. They are account permissions: they apply in the context of the account whose keys you are managing.

Permission	Description
`account:apikeys:create`	Create new API keys for the account.
`account:apikeys:read`	List and view API keys for the account.
`account:apikeys:update`	Edit key name and permissions for the account.
`account:apikeys:delete`	Revoke (delete) API keys for the account.
`account:apikeys:regenerate`	Regenerate the key secret for the account.

API ordering permissions (3-part: account:api_ordering:action)

Gate the headless ordering surface. Both are admin-grant-only — they don’t appear in the dashboard’s allowed-permissions picker by default. Contact support to request them.

Permission	Description
`account:api_ordering:write`	Place wallet-paid orders via `POST /v4/account/orders/create`.
`account:api_ordering:read`	Read the wallet balance via `GET /v4/account/orders/balance` (optional `include_counts=1` for activity counts). Required for API keys; dashboard JWT callers do not need this grant.

For the complete, up-to-date list and structure (including any account-specific permissions), call GET /v4/account/api-keys/permission-context.

​Product permissions (2-part: resource:action)

​Subaccount permissions

​Account API key permissions (3-part: account:apikeys:action)

​API ordering permissions (3-part: account:api_ordering:action)

Product permissions (2-part: resource:action)

Subaccount permissions

Account API key permissions (3-part: account:apikeys:action)

API ordering permissions (3-part: account:api_ordering:action)