Empty an Amazon Neptune DB cluster using the fast reset API

First, you generate a token that you can then use to perform the database reset. This step is intended to help prevent anyone from accidentally resetting a database.

You do this by sending an HTTP POST request to the /system endpoint on the writer instance of your DB cluster to specify the initiateDatabaseReset action.

The curl command using the JSON content-type would be:

curl -X POST \
  -H 'Content-Type: application/json' \
      https://your_writer_instance_endpoint:8182/system \
  -d '{ "action" : "initiateDatabaseReset" }'

Or, using the x-www-form-urlencoded content type:

curl -X POST \
  -H 'Content-Type: application/x-www-form-urlencoded' \
      https://your_writer_instance_endpoint:8182/system \
  -d 'action=initiateDatabaseReset '

The initiateDatabaseReset request returns the reset token in its JSON response, like this:

{
  "status" : "200 OK",
  "payload" : {
    "token" : "new_token_guid"
  }
}

The token remains valid for one hour (60 minutes) after it is issued.

If you send the request to a reader instance or to the status endpoint, Neptune will throw a ReadOnlyViolationException.

If you send multiple initiateDatabaseReset requests, only the latest token generated will be valid for the second step, where you actually perform the reset.

If the server restarts right after your initiateDatabaseReset request, the generated token becomes invalid, and you need to send a new request to get a new token.

Next, you send a performDatabaseReset request with the token that you got back from initiateDatabaseReset to the /system endpoint on the writer instance of your DB cluster. This deletes all data from your DB cluster.

The curl command using the JSON content-type is:

curl -X POST \
  -H 'Content-Type: application/json' \
      https://your_writer_instance_endpoint:8182/system \
  -d '{
        "action" : "performDatabaseReset",
        "token" : "token_guid"
      }'

Or, using the x-www-form-urlencoded content type:

curl -X POST \
  -H 'Content-Type: application/x-www-form-urlencoded' \
      https://your_writer_instance_endpoint:8182/system \
  -d 'action=performDatabaseReset&token=token_guid'

The request returns a JSON response. If the request is accepted, the response is:

{
  "status" : "200 OK"
}

If the token you sent doesn't match the one that was issued, the response looks like this:

{
  "code" : "InvalidParameterException",
  "requestId":"token_guid",
  "detailedMessage" : "System command parameter 'token' : 'token_guid' does not match database reset token"
}

If the request is accepted and the reset begins, the server restarts and deletes the data. You cannot send any other requests to the DB cluster while it is resetting.

Set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables correctly (and also AWS_SECURITY_TOKEN if you are using temporary credential).

An initiateDatabaseReset request looks like this:

awscurl -X POST --service neptune-db "$SYSTEM_ENDPOINT" \
  -H 'Content-Type: application/json' --region us-west-2 \
  -d '{ "action" : "initiateDatabaseReset" }'

A performDatabaseReset request looks like this:

awscurl -X POST --service neptune-db "$SYSTEM_ENDPOINT" \
  -H 'Content-Type: application/json' --region us-west-2 \
  -d '{ "action" : "performDatabaseReset" }'