Skip to content
WP Engine |Hosting Platform API

Get the offload settings for an install

GET
/installs/{install_id}/offload_settings/files

Returns the offload settings configuration for a specific install

install_id
required
string format: uuid

ID of install

LargeFS offload settings configuration

object
largefs_settings
object
cloud
string
Allowed values: s3
bucket
string
bucket_region
string
path_settings
Array<object>
object
path
string
excluded_paths
Array<string>
redirect_type
string
Allowed values: break permanent

Authentication Error

object
message
required

A message regarding the error that occurred on the server

string
Example
Bad Credentials
documentation_url

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

string

Not authorized

object
message
required

A message regarding the error that occurred on the server

string
Example
You don't have permission to perform that action
documentation_url

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

string

Not found

object
message
required

A message regarding the error that occurred on the server

string
Example
Not Found
documentation_url

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

string

Too many requests

Service unavailable