Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Org

Register and manage Salesforce orgs

sfp server org delete

This command allows a sfp server administrator to delete a registered salesforce org in the sfp server

USAGE
  $ sfp server org delete -u <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [-g <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -u, --username=<value>            (required) The username of the org that is locally authenticated
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  This command allows a sfp server administrator to delete a registered salesforce org  in the sfp server

EXAMPLES
  $ sfp server org delete --username test@example.com --email admin@example.com

sfp server org get-default-devhub

Get the default DevHub from the server with authentication details

USAGE
  $ sfp server org get-default-devhub [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-g
    <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --repository=<value>          Use the default DevHub for this registered repository (explicit opt-in)
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Get the default DevHub from the server with authentication details

EXAMPLES
  $ sfp server org get-default-devhub --email admin@example.com

  $ sfp server org get-default-devhub --email admin@example.com --json

sfp server org monitor-limits

Monitor Salesforce org limits - fetch current limits, compute usage percentages, and ingest metrics to VictoriaMetrics. This command is typically run by Hatchet scheduled jobs or manually for testing.

USAGE
  $ sfp server org monitor-limits --environment <value> --target-org <value> [--json] [--repository <value>] [-e <value>] [-t
    <value>] [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --environment=<value>         (required) Environment name as registered in the server
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url
      --target-org=<value>          (required) Salesforce target org username or alias to monitor

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Monitor Salesforce org limits - fetch current limits, compute usage percentages, and ingest metrics to
  VictoriaMetrics. This command is typically run by Hatchet scheduled jobs or manually for testing.

EXAMPLES
  $ sfp server org monitor-limits --repository myorg/myrepo --environment prod --target-org admin@example.com

  $ sfp server org monitor-limits --repository myorg/myrepo --environment prod --target-org admin@example.com --json

sfp server org register

This command allows a sfp server administrator to register a salesforce org to the sfp server, either from a locally authenticated (web login) org or headlessly via an External Client App JWT credential (--auth-type jwt)

USAGE
  $ sfp server org register -u <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [--auth-type sfdxAuthUrl|jwt] [--client-id <value>] [--jwt-key-file <value>] [--instance-url <value>]
    [--devhub] [--default] [--metadata <value>...] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -u, --targetusername=<value>      (required) The username of the org. For the default auth type the org must be
                                    locally authenticated; for --auth-type jwt it is the JWT subject and no local
                                    authentication is required
      --auth-type=<option>          [default: sfdxAuthUrl] Credential shape to register: 'sfdxAuthUrl' (default, from
                                    the locally authenticated org) or 'jwt' (External Client App / connected app JWT
                                    bearer — no local login needed)
                                    <options: sfdxAuthUrl|jwt>
      --client-id=<value>           Consumer key of the External Client App (or connected app) with JWT bearer flow
                                    enabled (required for --auth-type jwt)
      --default                     Mark this as the default DevHub (only one org can have this set)
      --devhub                      Mark this org as a DevHub
      --instance-url=<value>        Login/instance URL of the org, e.g. https://mycompany.my.salesforce.com (required
                                    for --auth-type jwt)
      --jwt-key-file=<value>        Path to the PEM-encoded RSA private key whose certificate is uploaded on the app
                                    (required for --auth-type jwt)
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --metadata=<value>...         Additional metadata as key=value pairs (comma separated) or JSON
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  This command allows a sfp server administrator to register a salesforce org to the sfp server, either from a locally
  authenticated (web login) org or headlessly via an External Client App JWT credential (--auth-type jwt)

EXAMPLES
  $ sfp server org register --targetusername myorg@example.com --email admin@example.com

  $ sfp server org register --auth-type jwt -u integration@example.com --client-id <CONSUMER_KEY> --jwt-key-file server.key --instance-url https://mycompany.my.salesforce.com --devhub --default

sfp server org register-sandbox

Register a Salesforce sandbox with the sfp server using credentials from an already registered production org

USAGE
  $ sfp server org register-sandbox -s <value> -p <value> [--json] [--repository <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -p, --productionusername=<value>  (required) The username of the production org (must be already registered with the
                                    server)
  -s, --sandboxname=<value>         (required) The name of the sandbox to register
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Register a Salesforce sandbox with the sfp server using credentials from an already registered production org

EXAMPLES
  $ sfp server org register-sandbox --sandboxname dev1 --productionusername prod@example.com --email admin@example.com

sfp server org token

Mint a short-lived Salesforce access token from the sfp server for a pool sandbox or a scratch / registered org, without handling the long-lived refresh token locally. The org's parent (production org for a sandbox, devhub/pool for a scratch org) is resolved automatically. Use the token with sfp org login --access-token <token> --instance-url <url>.

USAGE
  $ sfp server org token [--json] [-r <value>] [-e <value>] [-t <value>] [--sfp-server-url <value>] [-s <value> | -u
    <value>] [-g <value>...] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -r, --repository=<value>          Optional repository identifier (owner/repo) to scope the sandbox parent-org lookup.
  -s, --sandbox-name=<value>        Name of a pool sandbox to mint a token for (e.g. 719350). The parent production org
                                    is auto-resolved. Provide this OR --username.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -u, --username=<value>            Username of a scratch-pool org or a registered org to mint a token for. Provide this
                                    OR --sandbox-name.
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Mint a short-lived Salesforce access token from the sfp server for a pool sandbox or a scratch / registered org,
  without handling the long-lived refresh token locally. The org's parent (production org for a sandbox, devhub/pool for
  a scratch org) is resolved automatically. Use the token with `sfp org login --access-token <token> --instance-url
  <url>`.

EXAMPLES
  $ sfp server org token --sandbox-name 719350

  $ sfp server org token --sandbox-name 719350 --repository myorg/myrepo

  $ sfp server org token --username my-scratch@example.com.scratch

sfp server org update

Update a Salesforce org registration with DevHub status, default flag, or metadata

USAGE
  $ sfp server org update -u <value> [--json] [--repository <value>] [-e <value>] [-t <value>] [--sfp-server-url
    <value>] [--devhub] [--default] [--metadata <value>...] [--replace-metadata] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
  -u, --targetusername=<value>      (required) Username of the Salesforce org to update
      --[no-]default                Mark this as the default DevHub
      --[no-]devhub                 Mark this org as a DevHub
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --metadata=<value>...         Metadata to update as key=value pairs or JSON (merged by default)
      --replace-metadata            Replace metadata instead of merging
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Update a Salesforce org registration with DevHub status, default flag, or metadata

EXAMPLES
  $ sfp server org update --targetusername myorg@example.com --devhub --default

  $ sfp server org update --targetusername myorg@example.com --metadata environment=staging --metadata region=eu

  $ sfp server org update --targetusername myorg@example.com --metadata '{"team":"platform","tier":"premium"}' --replace-metadata

Logs

View logs for a tenant's services

Pool

Configure and monitor org pools

On this page

sfp server org deletesfp server org get-default-devhubsfp server org monitor-limitssfp server org registersfp server org register-sandboxsfp server org tokensfp server org update