Starts a catchpoint catchup.
POST /v2/catchup/{catchpoint}
POST
/v2/catchup/{catchpoint}
Given a catchpoint, it starts catching up to this catchpoint
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” catchpoint
required
string format: catchpoint
A catch point
Query Parameters
Section titled “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
Section titled “ Responses ”An catchpoint start response.
object
catchup-message
required
Catchup start response string
string
An catchpoint start response.
object
catchup-message
required
Catchup start response string
string
Bad Request
An error response with optional data field.
object
data
object
message
required
string
Invalid API Token
An error response with optional data field.
object
data
object
message
required
string
Request Timeout
An error response with optional data field.
object
data
object
message
required
string
Internal Error
An error response with optional data field.
object
data
object
message
required
string
default
Section titled “default ”Unknown Error