String getCheckpoint([String name, Boolean showSynchronizedOnly])

This getCheckpoint method retrieves checkpoints in the indexing process.

The name parameter corresponds to the checkpoint name. The default value is "".

If the showSynchronizedOnly parameter is set to false, you will see all checkpoints, even those that are not yet synchronized to disk. If set to true, you will see only synchronized checkpoints.

This page discusses:

HTTP method
HTTP parameters
HTTP response

HTTP method

The method used is:

GET no-cache http://<host>:<port>/papi/4/connectors/<connectorName>/get_checkpoint_info

HTTP parameters

The parameters are described in the table below.


Parameter	Location	Description
`PAPI_name`	`[URL]`	This parameter is used when you need to manage many checkpoints for a connector.
`PAPI_showSynchronizedOnly`	`[URL]`	This parameter is used to specify if you want to retrieve synchronized checkpoints only.
`PAPI_session`	`[URL]`	This optional parameter retrieves the session given by a previous call to `get_current_session_id` Action: if there is a session mismatch, the Push API server refuses the command and returns an exception.

HTTP response

The command uses the standard HTTP responses. See HTTP command response.

If successful (status = OK), then the body contains the serialized form of the checkpoint, which is the string value of the checkpoint.