Starts a catchpoint catchup.
POST /v2/catchup/{catchpoint}
POST
/v2/catchup/{catchpoint}
Given a catchpoint, it starts catching up to this catchpoint
Authorizations
Parameters
Path Parameters
catchpoint
required
string format: catchpoint
A catch point
Query Parameters
min
integer
Specify the minimum number of blocks which the ledger must be advanced by in order to start the catchup. This is useful for simplifying tools which support fast catchup, they can run the catchup unconditionally and the node will skip the catchup if it is not needed.
Responses
200
An catchpoint start response.
object
catchup-message
required
Catchup start response string
string
201
An catchpoint start response.
object
catchup-message
required
Catchup start response string
string
400
Bad Request
An error response with optional data field.
object
data
object
message
required
string
401
Invalid API Token
An error response with optional data field.
object
data
object
message
required
string
408
Request Timeout
An error response with optional data field.
object
data
object
message
required
string
500
Internal Error
An error response with optional data field.
object
data
object
message
required
string
default
Unknown Error