How to use the API

ColdStack Docs

Search…

ColdStack Docs

Introduction

ColdStack FAQ

Binance Smart Chain Bridge

Tools

S3 Compatible API

How to use the API

Preparation for work
To use the API, you need to get an access key id and secret key.
Static key authorization is required to access the HTTP API directly and is supported by the tools listed in the Supported Tools section .
For a list of supported Amazon S3 HTTP API methods, see the API Reference .
General view of the API request
{GET|HEAD|PUT|DELETE|MOVE} /<bucket>/<key> HTTP/1.1
Host: s3.coldstack.io
Content-Length: length
Date: date
Authorization: authorization string (AWS Signature Version 4)
​
Request_body
The bucket name can be specified as part of the hostname. In this case, the request will take the form:
{GET|HEAD|PUT|DELETE|MOVE} /<key>} HTTP/1.1
Host: <bucket>.s3.coldstack.io
...
The set of headers depends on the specific request and is described in the documentation for the corresponding request.
If you use the API directly (without SDK and applications), then you will have to generate the header yourself to sign the requests Authorization. For information on how to do this, see the Authenticating Requests (AWS Signature Version 4) section of the Amazon S3 documentation.
Request URL
The URL can take one of the following forms:
https://s3.coldstack.io/<bucket>/<key>?<parameters>
https://<bucket>.s3.coldstack.io/<key>?<parameters>

Python SDK (boto)

Next - S3 Compatible API

Signing Requests

Last modified 10mo ago

Copy link

Outline

Preparation for work

General view of the API request