voxel.voxcast.ondemand.locations.create

Set an origin and other configuration options for a specific directory tree ("path")

Parameters

device_id (required)
Numeric Voxel device id, available from voxel.devices.list
path (required)
The path of this Location

Authentication Settings

auth_required (optional)
Require (token-based) authentication for all requests regardless of headers. "true" or "false"
auth_failure_url (optional)
URL for redirection upon failed authentication.
auth_key (optional)
Authentication key string used to compute tokens.
allow_first (optional)
Set "true" to deny access by default (as in "allow,deny" access control nomenclature), or "false" to allow access by default.
referrer_allow_first (optional)
Set to "true" to deny access by default (as in "allow,deny" access control nomenclature), or "false" to allow access by default. This option controls access by referrers.

Cache Settings

cache_enable (optional)
Setting this to "false" disables caching for the specified location. If set to "inherit," settings from any parent directories will be used. If no parent directory is found, "inherit" will default to "true."
cache_ignore_scheme (optional)
If this is set to "false," a separate copy of cached files will be stored for files requested by http versus https. If set to "inherit," settings from any parent directories will be used. If no parent directory is found, "inherit" will default to "true." This setting is only applicable for devices in which incoming SSL requests are enabled.

Cache Hit Optimizations

cache_ignore_query_string (optional)
If set to "true," ignore query string when looking for content in the cache. Defaults to "false"

Origin Settings

origin_max_connections (optional)
Maximum simultaneous connections to the origin (> 0). Defaults to 2000.

http

origin_name (optional)
Origin server and path for incoming HTTP requests to this directory (e.g., http://origin.hostname.com/root/ or http://my-bucket.s3.amazonaws.com)
ssl_origin_name (optional)
Origin server and path for incoming HTTPS requests to this directory (e.g., https://origin.hostname.com/root/). If this field is not set, Voxel will use the HTTPS equivalent of the HTTP origin for SSL requests. This field is only valid for SSL enabled hosts; contact Voxel if you need assistance.

s3

s3_bucket (optional)
Amazon S3 bucket name. This is only necessary for authenticated S3 Origins (Origins that require an S3 key and secret). For non-authenticated S3 Origins, see origin_name.
s3_key (optional)
Amazon AWS access key, only applicable if the origin is an authenticated S3 bucket
s3_secret (optional)
Amazon AWS secret, only applicable if the origin is an authenticated S3 bucket

Example Response

<rsp stat="ok">
  <location location_id="1234"/>
</rsp>

Notes

None

Method Specific Error Codes

100: Unknown device
The device_id passed in can't be matched to a valid device.
201: Device action failed (reason)
An error occurred while performing an action on a device. A reason may be specified in parenthesis.