# API Reference

The ColdStack HTTP API provides the following services:

| Service                                       | Description                        |
| --------------------------------------------- | ---------------------------------- |
| [Bucket](#bucket-service)                     | Manages buckets.                   |
| [Object](#object-service)                     | Manages objects.                   |
| [Multipart upload](#multipart-upload-service) | Controls loading of large objects. |

### Supported Operations <a href="#operations-list" id="operations-list"></a>

#### Bucket service <a href="#bucket-service" id="bucket-service"></a>

| Method                                                                                                                     | Description                                            |
| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| [HeadBucket](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/bucket/getmeta)                    | Checks for the existence of a bucket and access to it. |
| [ListObjects/ListObjectsV2](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/bucket/listobjects) | Returns a list of objects in a bucket.                 |
| [ListBuckets](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/bucket/listbuckets)               | Returns a list of buckets.                             |
| [RenameBucket](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/bucket/renamebucket)             | Changes bucket's name.                                 |

#### Object service <a href="#object-service" id="object-service"></a>

| Method                                                                                                         | Description                                |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| [PutObject](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/object/upload)          | Loads an object into Object Storage.       |
| [GetObject](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/object/get)             | Unloads an object from Object Storage.     |
| [HeadObject](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/object/getobjectmeta)  | Unloads the object's metadata.             |
| [RenameObject](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/object/renameobject) | Changes object's key (renames the object). |

#### Multipart upload service <a href="#multipart-upload-service" id="multipart-upload-service"></a>

| Method                                                                                                                                | Description                   |
| ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| [CreateMultipartUpload](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/multipart-upload/startupload)      | Initializes a composite load. |
| [UploadPart](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/multipart-upload/uploadpart)                  | Loads part of an object.      |
| [CompleteMultipartUpload](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference/multipart-upload/completeupload) | Ends a multipart load.        |

### see also <a href="#see-also" id="see-also"></a>

* [How to use the API](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/how-to-use-the-api)
* [Supported tools](https://docs.coldstack.io/tools/supported-tools)