voxel.voxcast.ondemand.sites.list

Obtain a list of all your VoxCAST configurations.

Parameters

device_id (optional)
Numeric Voxel device id, available from devices.list
verbosity (optional)
Verbosity of response. Should be one of "compact", "normal", or "extended".

Example Response


<rsp stat="ok">
  <sites>
    <site device_id="1234" name="mysite.com">
      <cache_settings>
        <max_file_size unit="bytes">3221225472</max_file_size>
        <max_size unit="MB">3000</max_size>
        <default_expire unit="seconds">86400</default_expire>
        <max_expire unit="seconds">31556926</max_expire>
        <ignore_client_auth>false</ignore_client_auth>
        <store_queries_default_expire>true</store_queries_default_expire>
        <ignore_cache_control>true</ignore_cache_control>
        <ignore_token_name>mytoken=ignore</ignore_token_name>
        <ignore_headers/>
        <rm_consec_slashes>true</rm_consec_slashes>
        <preserve_on_revalidation_error>true</preserve_on_revalidation_error>
      </cache_settings>
      <proxy_settings>
        <preserve_hostname>false</preserve_hostname>
        <use_error_overrides>true</use_error_overrides>
      </proxy_settings>
      <locations>
        <location id="987" path="/">
          <origin type="http">
            <name>5678.origin.voxcdn.com/mysite.com/www</name>
            <max_connections>2000</max_connections>
          </origin>
          <authentication type="token" required="false">
            <failure_url>http://www.mysite.com/</failure_url>
            <key>zxRq4MbVVD</key>
          </authentication>
          <cache_settings>
            <enabled>true</enabled>
            <ignore_query_string>false</ignore_query_string>
          </cache_settings>
          <access_control default="allow" type="remote_host">
            <allow>all</allow>
          </access_control>
          <error_documents>
            <document response_code="505">http://5678.origin.voxcdn.com/mysite.com/www/error.html</document>
            <document response_code="404">"not found!"</document>
          </error_documents>
        </location>
        <location id="654" path="/images">
          <origin type="http">
            <name>img.5678.origin.voxcdn.com/mysite.com/www</name>
            <max_connections>2000</max_connections>
          </origin>
          <authentication type="token" required="false">
            <failure_url>http://www.mysite.com/</failure_url>
            <key>zxRq4MbVVD</key>
          </authentication>
          <cache_settings>
            <enabled>true</enabled>
            <ignore_query_string>false</ignore_query_string>
          </cache_settings>
          <auth default="allow"/>
        </location>
      </locations>
      <aliases>
        <alias>www.mysite.com</alias>
      </aliases>
    </site>
    ...
  </sites>
</rsp>

Notes

If device_id is specified, only the configuration for the requested device is returned.

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.