---
title: "POST /api/v1/pki/syncs/windows-server/test-health-check"
method: POST
path: "/api/v1/pki/syncs/windows-server/test-health-check"
tags: ["PKI Syncs"]
---

# POST /api/v1/pki/syncs/windows-server/test-health-check

`POST /api/v1/pki/syncs/windows-server/test-health-check`

## Request

- Base URL: `https://us.infisical.com`
- URL: `https://us.infisical.com/api/v1/pki/syncs/windows-server/test-health-check`
- Auth: none declared

Run a health check command against a Windows Server host without saving it to a sync.

## Request body

- object
  - `connectionId` string, uuid, required
  - `applicationId` string, uuid
  - `syncId` string, uuid
  - `certificateIds` string[]
  - `filters` object, nullable: Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing.
    - `profileIds` string[]: Match certificates issued from any one of these certificate profiles.
    - `certificateOrderIds` string[]: Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed.
    - `metadata` object[]: Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key.
      - `key` string, required: Metadata key the certificate must carry.
      - `value` string: Metadata value the key must have. Omit it to match any value.
  - `destinationConfig` object, required
    - `destinationPath` string, required
    - `host` string
    - `port` integer: The port to reach the target host on. Defaults to the protocol's standard port.
    - `sslEnabled` boolean: Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption.
    - `sslRejectUnauthorized` boolean: Verify the host's WinRM certificate when using HTTPS.
    - `sslCertificate` string: CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only).
  - `syncOptions` object, required
    - `canRemoveCertificates` boolean
    - `includeRootCa` boolean
    - `includePrivateKey` boolean
    - `exportFormat` 'pem' | 'pkcs12' | 'jks'
    - `pemCertificateExtension` 'pem' | 'crt'
    - `combineCertificateChain` boolean
    - `keystoreAlias` string: Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase.
    - `includeTruststore` boolean: Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates.
    - `fileAccessRules` object[]
      - `identity` string, required
      - `access` 'read' | 'modify' | 'full-control', required
    - `healthCheckCommand` string, nullable
    - `postSyncCommand` string, nullable
    - `certificateNameSchema` string

## Response `200`

Default Response

- object
  - `healthCheck` object, required
    - `status` 'pending' | 'running' | 'succeeded' | 'failed', required
    - `exitCode` number
    - `timedOut` boolean
    - `durationMs` number, required
    - `output` string
    - `failureDetail` string
    - `message` string

## Other responses

- `400`: Default Response
- `401`: Default Response
- `403`: Default Response
- `404`: Default Response
- `422`: Default Response
- `500`: Default Response

## Changes

- **2026-10-07** `8378abf16138`: 3 info
  - added the new optional request property `syncOptions/includeTruststore`
  - added the new optional request property `syncOptions/keystoreAlias`
  - added the new `jks` enum value to the request property `syncOptions/exportFormat`
- **2026-09-17** `7a0c98551644`: 1 info
  - added the new optional request property `filters`
- **2026-09-06** `d6550299d018`: 5 info
  - added the new optional request property `destinationConfig/host`
  - added the new optional request property `destinationConfig/port`
  - added the new optional request property `destinationConfig/sslCertificate`
  - added the new optional request property `destinationConfig/sslEnabled`
  - …1 more
- **2026-08-27** `e15904efcbcd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/infisical/apis/infisical-api/changes/api/v1/pki/syncs/windows-server/test-health-check/post.md)

---

[API](https://skmtc.dev/infisical/apis/infisical-api.md) - [All operations](https://skmtc.dev/infisical/apis/infisical-api/llms.txt) - [OpenAPI document](https://skmtc.dev/infisical/apis/infisical-api/revisions/7f940199c899?raw)