v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Files

Extract a file.

For a given site, extract a given file.

post/v1/sites/{id}/files/extract

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

filestring required

Name of the archive to extract

destinationstring required

location to extract the archive to

Example request

{
  "file": "backup.tar.gz",
  "destination": "blog_posts"
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "success": true,
    "path": "wp-content/plugins"
  }
}