Prunes the node database.

POST 
http://127.0.0.1:14265/api/core/v2/control/database/prune

Prunes the node database.

Request

application/json

Body

index integer

The pruning target index.

depth integer

The pruning depth.

targetDatabaseSize string

The target size of the database in bytes.

Responses

200

Successful operation.

application/json

Schema

Schema

index integerrequired

The index of the snapshot.

Example (from schema)

{
  "index": 0
}

default

{
  "index": 1560
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'http://127.0.0.1:14265/api/core/v2/control/database/prune' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "index": 0,
  "depth": 0,
  "targetDatabaseSize": "string"
}'

Request Collapse all

Base URL

http://127.0.0.1:14265

Body

• Example (from schema)
• default

{
  "index": 0,
  "depth": 0,
  "targetDatabaseSize": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!