# Cluster Operations

# Create Snapshot (for backups)

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.

You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.

JavaScript
Python
Ruby
Shell
Other Languages

client.operations.perform('snapshot', {'snapshot_path': '/tmp/typesense-data-snapshot'})

client.operations.perform('snapshot', {'snapshot_path': '/tmp/typesense-data-snapshot'})

client.operations.perform('snapshot', {'snapshot_path': '/tmp/typesense-data-snapshot'})

curl "http://localhost:8108/operations/snapshot?snapshot_path=/tmp/typesense-data-snapshot" -X POST \
-H "Content-Type: application/json" \
-H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

Typesense has a RESTful HTTP API.
So you can use any HTTP library in your language of choice to make API calls to it.
The official client libraries are just thin wrappers around the API, with a retry mechanism.
Have a look at the "Shell" tab for guidance on HTTP headers, method and parameters to use to make HTTP calls.

# Sample Response

JSON

{
  "success": true
}

# Definition

POST ${TYPESENSE_HOST}/operations/snapshot

# Arguments

Parameter	Required	Description
snapshot_path	yes	The directory on the server where the snapshot should be saved.

# Re-elect Leader

Triggers a follower node to initiate the raft voting process, which triggers leader re-election.

The follower node that you run this operation against will become the new leader, once this command succeeds.

JavaScript
Python
Ruby
Shell
Other Languages

client.operations.perform('vote')

client.operations.perform('vote')

client.operations.perform('vote')

curl "http://localhost:8108/operations/vote" -X POST \
-H "Content-Type: application/json" \
-H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

Typesense has a RESTful HTTP API.
So you can use any HTTP library in your language of choice to make API calls to it.
The official client libraries are just thin wrappers around the API, with a retry mechanism.
Have a look at the "Shell" tab for guidance on HTTP headers, method and parameters to use to make HTTP calls.

# Sample Response

JSON

{
  "success": true
}

# Definition

POST ${TYPESENSE_HOST}/operations/vote