COMMAND EVERYTHING.

ConvertTo-Json

Serialize a small PowerShell object into compact JSON for an API payload.

Last verified: 2026-10-26

Returns a JSON string. Property order is not guaranteed and deep objects may require a larger Depth setting.

ConvertTo-Json [-InputObject] <Object> [-Depth <Int32>] [-Compress]
 [-EnumsAsStrings] [-AsArray] [-EscapeHandling <StringEscapeHandling>]
 [<CommonParameters>]

Required permissions

No elevation is required for the in-memory examples. Filesystem operations require read or traversal access to the selected path.

Supported environments

PowerShell · 7.6; filesystem examples require the FileSystem provider

Parameters

-Compress

Removes unnecessary whitespace from the generated JSON.

Prerequisites

PowerShell 7.6 with Microsoft.PowerShell.Utility. For file examples, replace the sample path with an accessible file or directory.

Security considerations

Low risk for the supplied example. Protect file contents, paths, and returned system metadata. Review any modifications to the example before execution.

Examples

@{ name = 'demo'; enabled = $true } | ConvertTo-Json -Compress

Sources

https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/convertto-json?view=powershell-7.6

Explain or customize this command with AI

Related commands

Get-Process

Get-Random

Get-Date

Get-FileHash