Archive or restore a path

🔑

Required OAuth scope: paths:write.

Archives or restores a path.

Archiving a path doesn't delete its contents or statistics. It simply prevents the path from being added to new ones or creating new sessions. The archived path will still be accessible in existing paths, but it will be hidden from search results.

⚠️

Before archiving a path, make sure all its sessions are ended.

Path Params
string
required
^[a-fA-F0-9]{24}$

The unique ID of the path.

Body Params
boolean
required

If true, archives the path. If false, restores the path.

Headers
string
enum
required

The version of the API.

Allowed:
Responses
200

Returns the updated path.

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