Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
restart
Restart instance
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/restart \
  --header 'Client-Token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

If you, like every good developer, skipped the introduction and don’t yet have a clear understanding of what an instance is, I strongly suggest you take a step back and read the introduction to this topic. This feature works like your operating system’s restart button, useful for troubleshooting issues.
No! You do not need to scan the QRCode if you restart your instance.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Response

​
200

{
  "value": true
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.