Skip to content
WP Engine Documentation

Get the validation file needed to configure LargeFS

GET
/installs/{install_id}/offload_settings/largefs_validation_file
curl --request GET \
--url https://api.wpengineapi.com/v1/installs/example/offload_settings/largefs_validation_file \
--header 'Authorization: Basic <credentials>'

Returns the validation filename and contents necessary to configure an S3 bucket for LargeFS

install_id
required
string format: uuid

ID of install

LargeFS validation filename and contents

Media type application/json
object
name
string
content
string
Example
{
"name": "64f1250c.largefs",
"content": "e4ccd0696cff6f94"
}

Authentication Error

Media type application/json
object
message
required

A message regarding the error that occurred on the server

string
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string
Example
{
"message": "Bad Credentials"
}

Not authorized

Media type application/json
object
message
required

A message regarding the error that occurred on the server

string
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string
Example
{
"message": "You don't have permission to perform that action"
}

Not found

Media type application/json
object
message
required

A message regarding the error that occurred on the server

string
documentation_url

(Optional) A URL where documentation regarding this specific error can be found

string
Example
{
"message": "Not Found"
}

Too many requests

Media type application/json

Service unavailable

Media type application/json