request
Send a raw HTTP request to the Dataverse Web API. Note: on Git Bash/MSYS a leading-slash --path (e.g. /api/data/v9.2/accounts) is rewritten into a Windows path before it reaches the CLI; prefix with MSYS_NO_PATHCONV=1, set MSYS2_ARG_CONV_EXCL='*', or run from PowerShell/cmd.
Usage
ppds api request [options]
Options
| Long | Short | Type | Default | Description |
|---|---|---|---|---|
--body | string | Request body as inline JSON string | ||
--body-file | string | Request body from file (mutually exclusive with --body) | ||
--confirm | bool | Bypass write protection on production environments | ||
--correlation-id | string | Correlation ID for distributed tracing | ||
--debug | bool | Show trace-level diagnostic output | ||
--environment | -env | string | Target environment URL (default: active profile) | |
--header | -H | String[] | Additional header, repeatable (format: "Name: Value") | |
--include | -i | bool | Include HTTP status line and response headers in output | |
--method | -X | string | HTTP method (default: GET) | |
--output-format | -f | OutputFormat | Output format | |
--path | string | Relative URL path (e.g., /api/data/v9.2/accounts) | ||
--profile | -p | string | Authentication profile to use (default: active profile) | |
--quiet | -q | bool | Show only warnings and errors | |
--verbose | -v | bool | Show detailed output including debug messages |