For the full BlackPearl DS3 API Command sheet and user guide, see:
https://support.spectralogic.com/documentation/default-source/user-guides/blackpearl-ds3-api-reference.pdf
A standard programming language such as C# (.NET), Java, or Python can be used to send a series of DS3 commands to the library. In addition to sending the DS3 commands, the programs can parse the data that the library returns as the command response and interpret any output generated by the command.
All of the DS3 commands use standard HTTP URL structure. The general syntax for a DS3 command is:
Request_Type http[s]://{datapath DNS name}/[_rest_]/[{rest domain}]/
[{item specification}]?[{parameter 1}={value}]&[{parameter 2}={value}]&...&
[{parameter n}={value}
Where:
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}& • DS3 only supports the "path-style" bucket specification, not the "virtual-hostedstyle".
For DS3-style GET requests (with “/_rest_/” in the syntax), wild cards are allowed in string parameters.
The DS3 API uses Amazon S3 Signature Version 2 headers to pass authentication information.
The following table describes headers that can be used by various requests.
Note: CRC_32, MD5, and SHA-512 perform the best for their corresponding cryptographic strengths on the BlackPearl gateway.
| Header Name | Description |
| ContentCRC32 | The base64 encoded CRC32 checksum described in RFC 1952. This is limited to about 800 MB/sec per data stream. |
| ContentCRC32C | The base64 encoded CRC32C checksum described in RFC 3720 section B4. This is limited to about 300 MB/sec per data stream. |
| Content-MD5 | The base64 encoded 128 bit MD5 cryptographic checksum. This is limited to about 200 MB/sec per data stream. |
| ContentSHA256 | The base64 encoded 256 bit SHA cryptographic checksum. This is limited to about 75 MB/sec per data stream. |
| ContentSHA512 | The base64 encoded 512 bit SHA cryptographic checksum. This is limited to about 100 MB/sec per data stream. |
| NamingConvention | The naming convention for the response tags. Values: CONCAT_LOWERCASE, CONSTANT, UNDERSCORED, CAMEL_CASE_WITH_ FIRST_LETTER_UPPERCASE, CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE Default: CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE |