Spectra Logic

1-800-833-1132 : 1-303-449-6400

Command Syntax

All of the Spectra S3 commands use standard HTTP URL structure. The general syntax for a Spectra S3 command is:

Request_Type http[s]://{datapath DNS name}/[_rest_]/[{rest domain}]/[{item specification}]/?[{parameter 1}={value}] &[{parameter 2}={value}]&...&[{parameter n}={value}

where:

§	Request_Type = The HTTP request type (DELETE, GET, HEAD, POST, PUT)

§	{datapath DNS name} = The DNS name or IP address for the BlackPearl Deep Storage Gateway.

§	[_rest_] = Indicates that the operation is a Spectra S3-style request.

§	[{rest domain}] = The type of item that is acted upon by the request, for example, object, bucket, job.

§	[{item specification}] = The specification for the specific item that is acted upon by the request.

§	[{parameter 1}] through [{parameter n}] = Parameters whose values further define how the library responds to the request.

Notes:

§	The first parameter must be separated from the base URL by a question mark (?) and from any additional parameters by an ampersand (&).

§	To set a parameter to null use &{parameter n}=& or &{parameter n}&

§	Spectra S3 only supports the "path-style" bucket specification, not the "virtual-hosted-style".

This reference uses the following conventions for describing the syntax and command response for each command:

§	Optional parameters are shown in square brackets ([  ]).

§	Variables in the command syntax are shown as {variable}. Do not include the bracket characters ({  }) when you type variables.