Skip to main content
POST
/
sites
/
environments
/
{env_id}
/
change-webroot-subfolder
Change webroot subfolder of environment
curl --request POST \
  --url https://api.kinqsta.com/v2/sites/environments/{env_id}/change-webroot-subfolder \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "web_root_subfolder": "/release_v1",
  "clear_all_cache": true,
  "refresh_plugins_and_themes": true
}
'
{
  "operation_id": "sites:change-webroot-subfolder-54fb80af-576c-4fdc-ba4f-b596c83f15a1",
  "message": "Environment webroot subfolder change in progress",
  "status": 202
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.kinqsta.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
env_id
string
required
Example:

"54fb80af-576c-4fdc-ba4f-b596c83f15a1"

Body

application/json
​
web_root_subfolder
string
required
Pattern: ^\/([a-zA-Z0-9_-]+\/?)*$
Example:

"/release_v1"

​
clear_all_cache
boolean
default:true
Example:

true

​
refresh_plugins_and_themes
boolean
default:true
Example:

true

Response

Environment webroot subfolder change action started. Check MyKinsta for status

​
operation_id
string
required
Example:

"sites:change-webroot-subfolder-54fb80af-576c-4fdc-ba4f-b596c83f15a1"

​
message
string
required
Example:

"Environment webroot subfolder change in progress"

​
status
number
required
Example:

202