> For the complete documentation index, see [llms.txt](https://docs.coldstack.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coldstack.io/http-api-compatible-with-amazon-s3/api-reference.md).

# API Reference

The ColdStack HTTP API provides the following services:

| Service                                                                                           | Description                        |
| ------------------------------------------------------------------------------------------------- | ---------------------------------- |
| [Bucket](/http-api-compatible-with-amazon-s3/api-reference.md#bucket-service)                     | Manages buckets.                   |
| [Object](/http-api-compatible-with-amazon-s3/api-reference.md#object-service)                     | Manages objects.                   |
| [Multipart upload](/http-api-compatible-with-amazon-s3/api-reference.md#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](/http-api-compatible-with-amazon-s3/api-reference/bucket/getmeta.md)                    | Checks for the existence of a bucket and access to it. |
| [ListObjects/ListObjectsV2](/http-api-compatible-with-amazon-s3/api-reference/bucket/listobjects.md) | Returns a list of objects in a bucket.                 |
| [ListBuckets](/http-api-compatible-with-amazon-s3/api-reference/bucket/listbuckets.md)               | Returns a list of buckets.                             |
| [RenameBucket](/http-api-compatible-with-amazon-s3/api-reference/bucket/renamebucket.md)             | Changes bucket's name.                                 |

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

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

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

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

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

* [How to use the API](/http-api-compatible-with-amazon-s3/how-to-use-the-api.md)
* [Supported tools](/tools/supported-tools.md)