limits Commands

Description for limits api display

For each limit, this command returns the maximum allocation and the remaining allocation based on usage. See this topic for a description of each limit: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm.

Examples for limits api display

Display limits in your default org:

Display limits in the org with alias "my-scratch-org":

Usage

sf limits api display

[--json]

-o TARGET-ORG

[--api-version API-VERSION]

Flags

--json

Optional

Format output as json.

Type: boolean

-o | --target-org TARGET-ORG

Required

Username or alias of the target org.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

Aliases for limits api display

Description for limits recordcounts display

Use this command to get an approximate count of the records in standard or custom objects in your org. These record counts are the same as the counts listed in the Storage Usage page in the Setup UI. The record counts are approximate because they're calculated asynchronously and your org's storage usage isn't updated immediately. To display all available record counts, run the command without the --sobject flag.

Examples for limits recordcounts display

Display all available record counts in your default org:

Display record counts for the Account, Contact, Lead, and Opportunity objects in your default org:

Display record counts for the Account and Lead objects for the org with alias "my-scratch-org":

Usage

sf limits recordcounts display

[--json]

[-s SOBJECT]

-o TARGET-ORG

[--api-version API-VERSION]

Flags

--json

Optional

Format output as json.

Type: boolean

-s | --sobject SOBJECT

Optional

API name of the standard or custom object for which to display record counts.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

Aliases for limits recordcounts display