Regenerate Api Token

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Generates a new API token for an agent and returns the updated agent, including the new api_token.

When to use it

Use it to rotate an agent's token, for example when it may have been exposed. Clients that call the agent with authentication enabled pass this token in the x-api-token header.

Required parameters

  • agent_id (path): the ID of the agent.

Response

A successful call returns 200 OK with the updated Agent object, including its status and url.

Related: Get an agent, Update an agent, Ask an agent

Path Params
string
required
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json