--- title: "Object Storage (old)" description: "Methods of the old Object Storage API version for working with S3" --- import {CustomTable} from '@selectel/docux/components' :::warning URLs and methods of this Object Storage API version will be supported until October 5, 2027. On October 5, 2027 at 11:00 (UTC+3), they will be disabled. Some features will [no longer be supported](/s3/manage/configure-storage-update/#unavailable-features). We recommend using the [new version of the Object Storage API](/api/object-storage/); for more details, see the [Configuring S3 after an update](/s3/manage/configure-storage-update/) instructions. ::: [S3](https://selectel.ru/services/cloud/storage/?utm_source=kb.selectel.ru\&utm_medium=innerreferral\&utm_campaign=Storage_191120_storagerestapi) provides developers with the ability to integrate storage with their own applications and websites. Interaction with the storage is organized based on the REST API. The documentation describes the currently available Storage REST API calls, along with request and response formats. Currently, you can perform the following operations using REST API requests: * create links that allow third-party users to upload files to the storage; * work with file versions; * create users and set access permissions for them; * download and decompress archives; * work with special pages, etc. Methods for authorization and obtaining an API token are described in the [Authorization and obtaining a token](/api/object-storage-swift-old/#authorization-and-getting-token) section of the Swift API (old) instructions. ## Limitations for additional users \{#restrictions-for-additional-users} Additional users have limitations when using the API, so the following actions must be performed by the primary S3 user: * creating a bucket; * deleting multiple files (using `?bulk-delete=true`); * creating or modifying users; * working with domains and custom SSL certificates; * purging the CDN cache; * obtaining logs; * creating temporary tokens (`/temptokens`). ## Bucket operations \{#container-operations} ### Creating an image gallery \{#create-image-gallery} #### Request parameters \{#create-image-gallery-request-parameters}
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/SEL\*\*\_\*\*\*\*/containerX-Auth-Token — authorization token; X-Container-Meta-Type: gallery — bucket type (in our case — gallery)Activates the display of images as a gallery
#### Request example \{#create-image-gallery-request-exmaple} ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_*****/container -H "X-Auth-Token: $token" -H "X-Container-Metatype: gallery" ``` If the request is successful, the API returns a response with code 204. #### Response example \{#create-image-gallery-response-example} ``` HTTP/1.1 202 Accepted Content-Length: 76 Content-Type: text/html; charset=UTF-8 Access-Control-Allow-Origin: * Access-Control-Expose-Headers: ``` ### Downloading a bucket as a zip archive \{#download-container-as-zip} The contents of any bucket can be downloaded as a zip archive. To do this, add the query parameter download-all-as-zip=\[archive name] to the link to your bucket, for example: ```bash wget https://api.selcdn.ru/v1/SEL_*****/container_name/?download-all-as-zip=container_name.zip ``` In public buckets, the zip archive download feature is disabled by default; to enable it, you must set the **X-Container-Meta-Allow-ZipDownload: true** header, for example: ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_***/container_name -H "X-Auth-Token: $token" -H "X-Container-Meta-Allow-ZipDownload: true" ``` The value of this X-Container-Meta-Allow-ZipDownload header is ignored in private buckets. To download the content of any public bucket as a zip archive, the following commands can be used: ```bash curl -i -XGET https://api.selcdn.ru/v1/SEL_*****/container?download-all-as-zip=test.zip -o name.zip ``` To download the content of any private bucket as a zip archive, the following commands can be used: ```bash curl -i -XGET https://api.selcdn.ru/v1/SEL_*****/container?download-all-as-zip=test.zip -H "X-Auth-Token: $token" -o name.zip ``` To view the contents of the downloaded archive, use the following command: ``` unzip -l name.zip Archive: name.zip warning [name.zip]: 274 extra bytes at beginning or within zipfile (attempting to process anyway) Length Date Time Name --------- ---------- ----- ---- 555436 1980-00-00 00:00 IMG_20180802_121146.jpg 39 1980-00-00 00:00 copied_file 245473 1980-00-00 00:00 mergetree.pdf --------- ------- 800948 3 files ``` This operation is primarily intended for ease of downloading, not for traffic saving, so files in the archive are not compressed. The number of objects in a single bucket must not exceed 10,000, otherwise the command will fail and return an error. You can download objects starting with a specific prefix (e.g., IMG) as a zip archive by specifying the prefix IMG in the IMG?download-all-as-zip parameter: ```bash curl -i -XGET https://*****.selcdn.ru/container/?IMG?download-all-as-zip=test.zip -H "X-Auth-Token: $token" -o name.zip ``` *Note: if a folder starting with the same prefix is included among the objects, it will also be downloaded along with all of its contents.* ### Downloading a folder as a zip archive The contents of any folder can be downloaded as a zip archive. To do this, add the query parameter download-all-as-zip=\[archive name] to the link to the folder, for example: ```bash wget https://api.selcdn.ru/v1/SEL_*****/container_name/folder/?download-all-as-zip=container_name.zip ``` To download the content of any folder as a zip archive, the following commands can be used: ```bash curl -i -XGET https://*****.selcdn.ru/container/folder?download-all-as-zip=test.zip -H "X-Auth-Token: $token" -o name.zip ``` To view the contents of the downloaded archive, use the following command: ``` unzip -l name.zip Archive: name.zip warning [name.zip]: 274 extra bytes at beginning or within zipfile (attempting to process anyway) Length Date Time Name --------- ---------- ----- ---- 555436 1980-00-00 00:00 IMG_20180802_121146.jpg 39 1980-00-00 00:00 copied_file 245473 1980-00-00 00:00 mergetree.pdf --------- ------- 800948 3 files ``` This operation is primarily intended for ease of downloading, not for traffic saving, so files in the archive are not compressed. The number of objects in a single folder must not exceed 10,000, otherwise the command will fail and return an error. ## Working with files \{#files} ### Extracting archives \{#unpack-archives} Archives in \*.tar, \*.tar.gz, and \*.gzip formats can be extracted immediately after uploading to the storage. To extract an archive, add the query parameter extract-archive to the file upload request: ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_*****/new_container/archive.tar.gz/?extract-archive=tar.gz \ -H "X-Auth-Token: $token" -T "archive.tar.gz" ``` ### Creating a symbolic link to a file \{#create-symbolic-link-to-file} When using storage as a backend for public services, it is often necessary to restrict access to files — for example, to make files placed in a private bucket available to a wide range of users. Storage provides the ability to create symbolic links for such cases. Such links can be password-protected, and you can also set an expiration date for them.
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/container/file/the address specifies the bucket where the symbolic link will be stored and the name under which this link will be saved/X-Auth-Token — authorization token; Content-Type — type of symbolic link (x-storage/onetime-symlink — one-time link, x-storage/symlink+secure — regular password-protected link, x-storage/onetime-symlink+secure — one-time password-protected link); X-Object-Meta-Location — quoted path to the object in storage; X-Object-Meta-Delete-At — date (in Unix Timestamp format) until which the link will be valid; X-Object-Meta-Link-Key — sha1 hash of the password and object location (for password-protected links; for details, see Python Python X-Object-Meta-Link-Key generation example); Content-Disposition — indicates what to do with the linked file: open in browser (inline) or download to the local machine (attachment)Creates a symbolic link with the parameters specified in the request.
##### Request example \{#create-symbolic-link-to-file-request-example} ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_*****/new_container/new_link \ -H "X-Auth-Token: $token" -H "Content-Type: x-storage/symlink" \ -H "X-Object-Meta-Location: /new_container/new_object" \ -H "X-Object-Meta-Link-Key: $key" -H "Content-Length: 0" ``` ##### Response example \{#create-symbolic-link-to-file-response-example} ``` HTTP/1.1 201 Created > etag: d41d8cd98f00b204e9800998ecf8427e > Last-Modified: Mon, 27 May 2013 13:34:34 GM ``` ##### Python X-Object-Meta-Link-Key generation example \{#create-symbolic-link-to-file-python-example} ``` import hashlib # location of file, always with container specified location = "/container/object" # password password = "12345" # concatenate password + location and encode it encoded_pass_loc = (password + location).encode('utf-8') # generate sha1-hash hash_object = hashlib.sha1(encoded_pass_loc) # convert sha1-hash to hexadecimal digits link_key = hash_object.hexdigest() # show calculated value print(link_key) ``` #### Creating a file download link \{#create-link-to-download-file} You can create special links that allow third-party users to download your files (including from private buckets). You do not need to make an API request to create such a link. Before generating links to account files, you must set the $key secret key yourself: ```bash curl -i -XPOST http://*****.selcdn.ru/ -H "X-Auth-Token: $token" -H "X-Account-Meta-Temp-URL-Key: $key" ``` To create a link to a specific bucket, set a secret key $key by adding the bucket name: ```bash curl -i -XPOST http://*****.selcdn.ru/container -H "X-Auth-Token: $token" -H "X-Container-Meta-Temp-URL-Key: $key" ``` Only users who are aware of the secret key will be able to access files using the generated link. #### Python example \{#create-link-to-download-file-python-example} ``` import hmac from hashlib import sha1 from time import time # access method (always GET) method = "GET" # reference valid 60 seconds expires = int(time()) + 60 # the path to the file in the repository, always with the container specified path = "/container/dir/file" # secret key link_secret_key = str.encode("$key") # generate access key hmac_body = str.encode('%s\n%s\n%s' % (method, expires, path)) # access key sig = hmac.new(link_secret_key, hmac_body, sha1).hexdigest() #show calculated values print(sig,expires) ``` When using a link in the format `https://api.selcdn.ru/v1/SEL_ * **/container_name/object_name` in the script above, the **path** variable should be in the format\*\*`/v1/SEL_ ***/container_name/object_name`\*\*. The key obtained as a result must then be specified in the link: ``` http://****.selcdn.ru/container/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=13909142 ``` where: * ` * ****.selcdn.ru` --- base domain; * `temp_url_sig` --- access key; * `temp_url_expires` --- the time until which the link is valid (unixtime). If a domain is attached to a bucket, it can be specified in the link. In this case, you do not need to specify the bucket name: ``` http://my.domain/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=1390914227 ``` Management of the Content-Disposition header for data sent via links is supported. To do this, add the filename parameter with the corresponding value: ``` http://*****.selcdn.ru/container/dir/file?temp_url_sig=3f512dfed32111d6e742afc5522076c0621951cc&temp_url_expires=1390914227&filename=Other+file+name.doc ``` The secret key can be changed. After changing the secret key, all previously generated links will stop working. #### Node.js example \{#create-link-to-download-file-node-js-example} ``` const crypto = require('crypto'); // access method (always GET) const method = 'GET'; // reference valid 60 seconds const expires = Math.floor(Date.now() / 1000) + 60; // the path to the file in the repository, always with the container specified const path = '/container/dir/file'; // secret key const linkSecretKey = '$key'; // generate access key const hmacBody = `${method}\n${expires}\n${path}`; // access key const sig = crypto.createHmac('sha1', linkSecretKey).update(hmacBody).digest('hex'); // show calculated values console.log(sig); console.log(expires); ``` #### Creating a link for uploading files (sendmefile) \{#create-link-to-upload-file}
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/container/upload X-Auth-Token — authorization token; Content-Type — link properties (x-storage/sendmefile+inplace — upload only one file with the specified name; x-storage/sendmefile+timepostfix — upload files with the upload time added to the name; x-storage/sendmefile+autopostfix — upload files with a unique identifier added to the name, taking the extension into account; x-storage/sendmefile+folderday — upload files to a folder named yyyy-dd-mm, x-storage/sendmefile+folderhour — upload files to a folder named dd-mm hh:min min, x-storage/sendmefile+folderuniq — upload each file to a separate folder); X-Object-Meta-Sendmefile-Disable-Web — enables (no)/disables (yes) the web interface for file uploading; this header is set to yes by default (web interface is enabled); X-Object-Meta-Sendmefile-Max-Size — maximum size of the uploaded file (in bytes); X-Delete-After — deletes the link after the specified time (in seconds); X-Object-Meta-Sendmefile-Allow-Overwrite — allows (yes) or denies (no) overwriting files upon re-upload (overwriting is disabled by default); X-Object-Meta-Sendmefile-Ignore-Filename — allow (yes) automatic file renaming according to the set settings; X-Object-Meta-Sendmefile-Secret — password hash (for password-protected links); -Sendmefile-Session-Id — upload session identifier Creates a link that allows third-party users to upload files to the storage. Link example: https://\*\*\*\*\*.selcdn.ru/container/upload, where \*\*\*\*\* is the base domain of the bucket in numeric form, specified in the Control Panel in the Bucket Settings card ⟶ Link for uploading files; container is the bucket name; upload is the name of the file upload link.
##### Request example \{#crea-examplete-link-to-upload-file-request} ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_*****/container/upload \ -H "X-Auth-Token: $token" -H "Content-Type: x-storage/sendmefile+inplace" \ -H "X-Object-Meta-Sendmefile-Max-Size: 52428800" \ -H "X-Delete-After: 14400" \ -H "X-Object-Meta-Sendmefile-Secret: 5baa61e4c9b93f3f0682250b6cf8331b7ee68" \ -d "Helper text for upload page" ``` ### Versioning \{#versioning} Storage provides support for versions so that you can store not only the latest version of an object but also several previous ones. Before you start working with versioning, create a bucket to store the versions. When an object is deleted, the last working version is not returned to its place. All versions of the object, including the one that was there before deletion, are stored in the bucket for versions. #### Request parameters \{#versioning-request-parameters}
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Versions-Location — name of the bucket where versions will be stored. The header will not work if a bucket for versions has not been createdActivates versioning for the specified bucket. Versions of all objects will be saved in the bucket whose name is passed in the header
#### Request example \{#versioning-request-example} ```bash curl -i -XPUT https://api.selcdn.ru/v1/SEL_*****/container1/ -H "X-Auth-Token: $token" -H "X-Versions-Location: container2" ``` If the request is successfully completed, a response with code 202 will be returned. #### Response example \{#versioning-response-example} ``` HTTP/1.1 202 Accepted Content-Length: 76 Content-Type: text/html; charset=UTF-8 Access-Control-Allow-Origin: * Access-Control-Expose-Headers: Expires: 0 Pragma: no-cache Cache-Control: no-cache, no-store, must-revalidate ``` ## Special pages \{#special-pages} Special pages include: * an index page returned in response to an anonymous GET request to a bucket or a folder placed in that bucket; * an error page (404) — a file returned during an anonymous GET request to a non-existent object. ### Index page \{#index-page} #### Request parameters \{#index-page-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Container-Meta-Web-Index — path to the file that will be used as an index fileAssigns an index file for the specified bucket
You can specify either an absolute or relative path to the file in the request.
Web-IndexRequestReturned file
/index.htmlGET /container/; GET /container/dir1//container/index.html
index.htmlGET /container//container/index.html
index.htmlGET /container/dir1/dir2//container/dir1/dir2/index.html or (if the file is missing) /container/index.html
#### Request example \{#index-page-request-example} Create an index file: ```bash echo "custom_index_file" > my_index.html curl -i -XPUT "https://api.selcdn.ru/v1/SEL_*****/container_name/my_index.html" -H "X-Auth-Token: $token" -T "./my_index.html" ``` To set the index page, set the Web-Index value for the bucket: ```bash curl -i -XPUT "https://api.selcdn.ru/v1/SEL_*****/container_name/my_index.html" \ -H "X-Auth-Token: $token" -H "X-Container-Meta-Web-Index:/my_index.html" ``` ### 404 page \{#error-page} #### Request parameters \{#error-page-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Container-Meta-Web-404-Page — path to the error fileConfigures an error file for the specified bucket
#### Examples \{#error-page-examples}
Web-404-PageRequestRedirect address
/404.htmlGET /container/nofile; GET /container/dir1/nofile/container/404.html
404.html/container/nofile/container/404.html
404.htmlGET /container/nofile/container/dir1/dir2/404.html or (if the file is missing) /container/404.html
http://test.testGET /container/nofile; /container/dir1/nofilehttp://test.test
#### Available template parameters \{#available-template-parameters} To pass information about the originally requested file, you can use special template parameters: * {'{container}'} --- bucket name; * {'{path}'} --- path to the requested file relative to the bucket. By default, redirection is performed with code 307. Available options: 200, 307, 404. When setting an external link, only code 307 can be set. #### Request example \{#available-template-parameters-request-example} Set the Web-404-Page value for the bucket: ```bash curl -i -XPOST "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Auth-Token: $token" \ -H "X-Container-Meta-Web-404-Page: /404.html?file={path}" ``` Upon an anonymous request for a non-existent object, redirection to the specified file occurs: ```bash curl -i "https://api.selcdn.ru/v1/SEL_*****/container_name/non_existing_object" \ > HTTP/1.1 307 Temporary Redirect > Location: https://api.selcdn.ru/v1/SEL_*****/404.html?file=non_existing_object ``` By default, when sending an error page, code 404 is returned: ```bash curl -i -XPOST "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Auth-Token: $token" \ -H "X-Container-Meta-Web-404-Page: /404.html?file={path}?{code}" ``` ### File listing \{#files-listing} #### Request parameters \{#files-listing-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Container-Meta-Web-Listings — on/off — enable or disable the listing mode for the bucket; X-Container-Meta-Web-Listings-CSS — link to a style file, used for outputs in HTML format (optional); X-Container-Meta-Web-Listings-Sort — listing sort type, possible values: name\_asc, name\_desc, date\_asc, date\_desc, size\_asc, size\_desc; you can sort by name, modification date, and size. Asc and desc determine the sort orderEnables the file listing mode for the bucket specified in the request
#### Request example \{#files-listing-request-example} ```bash curl -i -XPOST "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Auth-Token: $token" \ -H "X-Container-Meta-Web-Listings: on" ``` To receive file listing via an anonymous request, enter: ```bash curl -i -XGET "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Web-Mode: listing" ``` To receive a listing of a private bucket, specify the token of a user who has access to the bucket: ```bash curl -i -XGET "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Auth-Token: $token" -H "X-Web-Mode: listing" ``` For output in HTML format, you can define the design using the X-Container-Meta-Web-Listings-Css header, the value of which is the link to the style file in the bucket; you can also provide a link to an external style file.
Web-Listings-CSSBehavior
my.css or /my.cssThe style file located in the same bucket will be used
http://my\_site/my.cssA style file from an external site will be used
Setting the Web-Listings-CSS value for the bucket: ```bash curl -i -XPOST "https://api.selcdn.ru/v1/SEL_*****/container_name" -H "X-Auth-Token: $token" \ -H "X-Container-Meta-Web-Listings-Css: my_style.css" ``` ## User management \{#users} ### Viewing the user list \{#view-user-list} #### Request parameters \{#view-user-list-request-parameters}
Request typeURIHeadersDescription
GEThttps://api.selcdn.ru/v1/usersX-Auth-Token — authorization tokenReturns a list of users for the current account
#### Request example \{#view-user-list-request-xample} ```bash curl -i https://api.selcdn.ru/v1/users -H "X-Auth-Token: $token" ``` If the request is successful, the API returns a response with code 200. #### Response example \{#view-user-list-response-example} ``` HTTP/1.1 200 OK Access-Control-Allow-Origin: * Content-Type: text/plain; charset=utf-8 Content-Length: 80 ``` ``` main_user (true) main_user (true) user1 (true) user2 (true) user3 (true) ``` ### Adding a new user \{#add-new-user} #### Request parameters \{#add-new-user-request-parameters}
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/users/usernameX-Auth-Token — authorization token; X-Auth-Key — password for the new user; X-User-Active — user status (on — active, off — inactive); X-User-ACL-Containers-R — names of buckets to which the new user will have read-only access; X-User-ACL-Containers-W — list of buckets to which the new user will have write access; X-User-S3-Password — indicates that the password will be used for access via the S3 protocol (similar to the Use these credentials for S3 access option in the Control Panel)Creates a user with the specified account settings
#### Request example \{#add-new-user-request-example} ```bash curl -i -XPUT https://api.selcdn.ru/v1/users/my_test_user -H "X-Auth-Token: $token" -H "X-Auth-Key: $key" -H "X-User-ACL-Containers-W: container1, container2, container3" -H "X-User-ACL-Containers-R: container4" -H "X-User-S3-Password: yes" -H "X-User-Active: on" ``` If the request is successfully completed, the API returns a response with code 204. #### Response example \{#add-new-user-response-example} ``` HTTP/2 204 Created access-control-allow-origin: * Content-Type: text/html; charset=UTF-8 Content-Length: 0 ``` ### Deleting a user \{#delete-user} #### Request parameters \{#delete-user-request-parameters}
Request typeURIHeadersDescription
DELETEhttps://api.selcdn.ru/v1/users/usernameX-Auth-Token — authorization tokenDeletes the specified user
#### Request example \{#delete-user-request-example} ```bash curl -i -X DELETE https://api.selcdn.ru/v1/users/my_test_user -H "X-Auth-Token: $token" ``` If the user is successfully deleted, the API returns a response with code 204. #### Response example \{#delete-user-response-example} ``` HTTP/1.1 204 No Content Access-Control-Allow-Origin: * Content-Type: text/plain; charset=utf-8 X-Content-Type-Options: nosniff Date: Mon, 19 Mar 2018 10:04:25 GMT ``` ### Changing the primary user password \{#change-main-user-password} #### Request parameters \{#change-main-user-password-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/users/X-Auth-Token — authorization token; X-Auth-Key — new password; X-User-S3-Password — indicates that the password will be used for access via the S3 protocol (similar to the Use these credentials for S3 access option in the Control Panel)Changes the primary user password to the one passed in the X-Auth-Key header
#### Request example \{#change-main-user-password-request-example} ```bash curl -i -XPOST https://api.selcdn.ru/v1/users -H "X-Auth-Token: $token" -H "X-Auth-Key: $key" ``` If the request is successfully completed, the API returns a response with code 204. #### Response example \{#change-main-user-password-response-example} ``` HTTP/1.1 204 No Content Access-Control-Allow-Origin: * Content-Type: text/plain; charset=utf-8 X-Content-Type-Options: nosniff Date: Mon, 19 Mar 2018 10:30:59 GMT ``` ## Domain management \{#domains} Domains can be attached to buckets in the storage. All operations with domains are performed via the API. ### Default domains \{#default-domains} Each S3 user automatically receives a set of default domains that can be used to access objects in any bucket: * \*\*\*\*\*.selcdn.ru — domain for public access to files in the storage; * \*\*\*\*\*.selcdn.com — domain for distributing files via CDN over http. ### Getting the list of attached domains \{#get-list-of-attached-domains} #### Request parameters \{#get-list-of-attached-domains-request-parameters}
Request typeURIHeadersDescription
GEThttps://api.selcdn.ru/v1/domainsX-Auth-Token — authorization tokenReturns a list of domains
#### Request example \{#get-list-of-attached-domains-request-example} ```bash curl -i -XGET https://api.selcdn.ru/v1/domains -H "X-Auth-Token: $token" ``` If the request is successfully completed, the API returns a response with code 200. #### Response example \{#get-list-of-attached-domains-response-example} ``` HTTP/1.1 200 OK Content-Length: 69 Content-Type: text/html Date: Mon, 16 May 2016 07:36:35 GMT ``` ``` Base Domains: 00000.selcdn.ru 00000.selcdn.com Containers Domains: container1 domain1.ru container2 domain1.ru ``` ### Attaching a domain \{#add-domains} #### Request parameters \{#add-domains-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Add-Container-Domains — list of domains to be attached to the bucket, domains are separated by commasAttaches the domains passed in the X-Add-Container-Domains header to the bucket
#### Request example \{#add-domains-request-example} ```bash curl -i -XPOST https://api.selcdn.ru/v1/SEL_*****/container -H "X-Add-Container-Domains: domain1.ru" -H "X-Auth-Token: $token" ``` If the request is successfully completed, the API will return a response with code 204. #### Response example \{#add-domains-response-example} ``` HTTP/1.1 204 No Content Access-Control-Allow-Origin: * Access-Control-Expose-Headers: X-Backend-Timestamp, Etag, Last-Modified, X-Object-Manifest, X-Timestamp Content-Type: text/plain; charset=utf-8 X-Content-Type-Options: nosniff Date: Tue, 20 Mar 2018 12:09:38 GMT ``` ### Deleting a domain \{#delete-domain} #### Request parameters \{#delete-domain-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Remove-Container-Domains — list of domains to be detached from the bucket, domains are separated by commasDetaches the domains passed in the X-Remove-Container-Domains header from the bucket
#### Request example \{#delete-domain-request-example} ``` curl -i -XPOST https://api.selcdn.ru/v1/SEL_*****/container -H "X-Remove-Container-Domains: domain1.ru" -H "X-Auth-Token: $token ``` If the request is successfully completed, the API returns a response with code 204. #### Response example \{#delete-domain-response-example} ``` HTTP/1.1 204 No Content Access-Control-Allow-Origin: * Access-Control-Expose-Headers: X-Backend-Timestamp, Etag, Last-Modified, X-Object-Manifest, X-Timestamp Content-Type: text/plain; charset=utf-8 X-Content-Type-Options: nosniff ``` ### Editing the domain list \{#edit-list-of-domains} #### Request parameters \{#edit-list-of-domains-request-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/SEL\_\*\*\*\*\*\*/containerX-Auth-Token — authorization token; X-Container-Domains — list of domains to be attached to the bucket, domains are separated by commasAttaches the domains passed in the X-Container-Domains header to the bucket. Unlike X-Add-Container-Domains, this header completely replaces the list of attached domains rather than appending to it
#### Request example \{#edit-list-of-domains-request-example} ```bash curl -i -XPOST https://api.selcdn.ru/v1/SEL_*****/container -H "X-Container-Domains: domain1.ru" -H "X-Auth-Token: $token" ``` If the request is successfully completed, the API returns a response with code 204. #### Response example \{#edit-list-of-domains-response-example} ``` HTTP/1.1 204 No Content Access-Control-Allow-Origin: * Access-Control-Expose-Headers: X-Backend-Timestamp, Etag, Last-Modified, X-Object-Manifest, X-Timestamp Content-Type: text/plain; charset=utf-8 X-Content-Type-Options: nosniff ``` ## Managing custom SSL certificates \{#ssl-certificates} ### Getting the certificate list \{#get-list-of-certificates} #### Request parameters \{#get-list-of-certificates-request-parameters}
Request typeURIHeadersDescription
GEThttps://api.selcdn.ru/v1/sslX-Auth-Token — authorization tokenReturns a list of certificates
#### Request example \{#get-list-of-certificates-request-example} ```bash curl -i -XGET https://api.selcdn.ru/v1/ssl -H "X-Auth-Token: $token" ``` ### Getting certificate information \{#get-certificate-info} #### Request parameters \{#get-certificate-info-request-parameters}
Request typeURIHeadersDescription
GEThttps://api.selcdn.ru/v1/ssl/certX-Auth-Token — authorization tokenReturns information about the specified certificate
#### Request example \{#get-certificate-info-request-example} ```bash curl -i -XGET https://api.selcdn.ru/v1/ssl/cert -H "X-Auth-Token: $token" ``` ### Adding a certificate \{#add-certificate} #### Request parameters \{#add-certificate-request-parameters}
Request typeURIHeadersDescription
PUThttps://api.selcdn.ru/v1/ssl/\*\*\*\*\_\*\*cert1X-Auth-Token — authorization tokenAdds a new certificate
#### Request example \{#add-certificate-request-example} ```bash curl -i -XPUT https://api.selcdn.ru/v1/ssl/*****_cert1 -H "X-Auth-Token: $token" -T ./cert1.pem ``` The certificate name ({'{cert_name}'}) must be provided in the \* \*\*\*\*\_cert1 format, where the first part (digits) is the user account number and the second is any arbitrary combination of characters. Certificate names must be unique; it is impossible to upload two certificates with the same name. The certificate and private key itself must be passed in the request body in a single file. ### Deleting a certificate \{#delete-certificate} #### Request parameters \{#delete-certificate-request-certificate}
Request typeURIHeadersDescription
DELETEhttps://api.selcdn.ru/v1/ssl/certX-Auth-Token — authorization tokenDeletes the specified certificate
## Storage cache purge \{#clear-storage-cash} Request parameters: * Request type — POST; * URI --- `https://api.selcdn.ru/v1/storage/purge`; * Headers — authorization token X-Auth-Token; * Description — purges the S3 cache for pages whose addresses were passed in the request. Request example: ```bash curl -i -XPOST https://api.selcdn.ru/v1/storage/purge -H "x-auth-token: $token" -d '{"objects":["https://example.domain.ru/test_purge/file","https://example2.domain.ru/test_purge/file2"]}' ``` If the request is successfully completed, the API returns a response with code 200. Response example: ``` HTTP/2 200 content-type: application/json date: Fri, 27 Aug 2021 13:00:42 GMT content-length: 66 {"HttpStatus":201,"Detail":"Request accepted.","RejectedUrls":{}} ``` ## Getting logs \{#get-logs} ### Request to create an export \{#request-to-create-upload} #### Request parameters \{#request-to-create-upload-parameters}
Request typeURIHeadersDescription
POSThttps://api.selcdn.ru/v1/logsX-Auth-Token — authorization token; X-Start-Time — start of the period in Y-m-d H:M:S format; X-End-Time — end of the period in Y-m-d H:M:S format; X-Limit — maximum number of entries to return in the requestCreate a logs bucket and export storage logs to it
Request body: ``` { "since": "2019-05-14T06:00:00", "till": "2019-12-09T13:43:00", "fields": [ "container_name" ], "filters": { "host": [ "example.com", "foo.bar.baz" ] }, "container": "logs", "delete_after": 3600 } ``` Description of request body fields: * since — start of the period for export; * till — end of the period for export; * fields — list of required fields; * filters — filters for export; * container — bucket for export; * delete\_after — deletion of objects with logs after a specified time. List of possible fields (fields): * container\_name * timestamp * host * server\_to\_client\_bytes * client\_to\_server\_bytes * http\_method * status * path * query * client\_ip List of possible filters (filters): * host * container\_name #### Request example \{#request-to-create-upload-example} ``` curl -i -XPOST -H 'X-Auth-Token: $token' -d '{"since": "2019-05-14T06:00:00","till": "2019-12-09T13:43:00", "fields": ["container_name"], "filters": {"host": ["example.com", "foo.bar.baz"]}, "container": "logs", "delete_after": 3600}' 'https://api.selcdn.ru/v1/logs' ``` If the request is successfully completed, the API returns a response with code 200. #### Response example \{#request-to-create-upload-response-example} ``` HTTP/1.1 201 Created Access-Control-Allow-Origin: * Content-Length: 342 Content-Type: application/json Date: Tue, 14 Jan 2020 13:01:34 GMT { "task": { "id": "896aae80-bc7e-434d-8528-5ca2bfb41a56", "created": "2020-01-14T13:01:34", "updated": "2020-01-14T13:01:34", "type": "storage_logs", "data": { "since": "2019-05-14T06:00:00", "till": "2019-12-09T13:43:00", "provider": "storage_access", "container": "logs", "fields": ["container_name"], "filters": {"host": ["example.com", "foo.bar.baz"]}, "delete_after": 3600 }, "status": 0, "progress": 0 } } ``` ### Getting information about a created task \{#get-info-about-created-job} #### Request parameters \{#get-info-about-created-job-request-parameters}
Request typeURIHeadersDescription
GEThttps://api.selcdn.ru/v1/logs/$task\_idX-Auth-Token — authorization tokenCreate a logs bucket and export storage logs to it
#### Request example \{#get-info-about-created-job-request-example} ```bash curl -i -XPOST -H 'X-Auth-Token: $token' -d '{"since": "2019-05-14T06:00:00","till": "2019-12-09T13:43:00", "fields": ["container_name"], "filters": {"host": ["example.com", "foo.bar.baz"]}, "container": "logs", "delete_after": 3600}' 'https://api.selcdn.ru/v1/logs' ``` #### Response example \{#get-info-about-created-job-response-example} ``` { "task": { "id": "896aae80-bc7e-434d-8528-5ca2bfb41a56", "created": "2020-01-14T13:01:34", "updated": "2020-01-14T13:01:45", "type": "storage_logs", "data": { "till": "2019-12-09T13:43:00", "since": "2019-05-14T06:00:00", "fields": ["container_name"], "filters": {"host": ["example.com", "foo.bar.baz"]}, "provider": "storage_access", "container": "logs", "delete_after": 3600 }, "status": 2, "progress": 100 } } ```