Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Storage

Create storage

Creates a new storage instance (S3 or SFTP) in the specified location and returns the storage details including credentials.

Deprecated: Use POST /v4/object_storages for S3 storage or POST /v4/sftp_storages for SFTP storage instead.

put/storage/provisioning/v1/storage

Request body

generate_sftp_passwordboolean

Automatically generate a secure password for SFTP storage access. Only applicable when type is sftp. When true, a random password will be generated and returned in the response.

locationstring required

Geographic location where the storage will be provisioned. Each location represents a specific data center region.

namestring required

Unique storage name identifier. Must contain only letters, numbers, dashes, and underscores. Cannot be empty and must be less than 256 characters.

sftp_passwordstring

Custom password for SFTP storage access. Only applicable when type is sftp. If not provided and generate_sftp_password is false, no password authentication will be available.

type'sftp' | 's3_compatible' required

Storage protocol type. Choose 's3_compatible' for S3-compatible object storage with API access, or sftp for SFTP file transfer protocol.

Example request

{
  "generate_sftp_password": true,
  "location": "s-region-1",
  "name": "my-storage-prod",
  "type": "s3_compatible"
}

Response

Storage

addressstring required

Full hostname/address for accessing the storage endpoint

can_restoreboolean

Whether this storage can be restored if deleted (S3 storages only, within 2 weeks)

client_idinteger required

Client identifier who owns this storage

created_atstring date-time required

ISO 8601 timestamp when the storage was created

custom_config_fileboolean

Whether custom configuration file is used for this storage

deleted_atstring date-time

ISO 8601 timestamp when the storage was deleted (only present for deleted storages)

disable_httpboolean

Whether HTTP access is disabled for this storage (HTTPS only)

expiresstring date-time

ISO 8601 timestamp when the storage will expire (if set)

idinteger required

Unique identifier for the storage instance

locationstring required

Geographic location code where the storage is provisioned

namestring required

User-defined name for the storage instance

provisioning_status'creating' | 'ok' | 'updating' | 'deleting' | 'deleted' required

Current provisioning status of the storage instance

reseller_idinteger required

Reseller technical client ID associated with the client

rewrite_rulesobject

Custom URL rewrite rules for the storage (admin-configurable)

server_aliasstring

Custom domain alias for accessing the storage

type'sftp' | 's3_compatible' required

Storage protocol type - either S3-compatible object storage or SFTP file transfer

Example response

{
  "address": "s-region-1.storage.example.com",
  "can_restore": true,
  "client_id": 1,
  "created_at": "2025-08-05T09:17:02Z",
  "credentials": {
    "keys": [
      {
        "created_at": "2025-08-05T09:15:00Z",
        "id": 123,
        "name": "my-production-key"
      }
    ],
    "s3": {
      "access_key": "AKIAIOSFODNN7EXAMPLE",
      "secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
    },
    "sftp_password": "Xy9$mN2p!qR8"
  },
  "deleted_at": "2025-08-05T10:30:15Z",
  "expires": "2026-08-05T09:17:02Z",
  "id": 1,
  "location": "s-region-1",
  "name": "1-my-storage-prod",
  "provisioning_status": "ok",
  "reseller_id": 1,
  "server_alias": "my-storage.example.com",
  "type": "s3_compatible"
}