Setting the current S3 encryption setting

post /v1/s3_encryption/set

Implements S3 encryption on your system.

Request headers

X-XSRF-TOKEN String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: xXSRFTOKEN_example

Cookie String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: cookie_example

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: application/json'
      
          -H
          'X-XSRF-TOKEN: xXSRFTOKEN_example'
          -H
          'Cookie: cookie_example'
      
      'http://localhost/v1/s3_encryption/set'
    
      -d
      '{ }'

import http.client

conn = http.client.HTTPConnection("undefinedundefined")

headers = {
    'X-XSRF-TOKEN': "SOME_STRING_VALUE",
    'Cookie': "SOME_STRING_VALUE"
    }

conn.request("POST", "/v1/s3_encryption/set", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("http://undefinedundefined/v1/s3_encryption/set")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["X-XSRF-TOKEN"] = 'SOME_STRING_VALUE'
request["Cookie"] = 'SOME_STRING_VALUE'

response = http.request(request)
puts response.read_body

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://undefinedundefined/v1/s3_encryption/set");
xhr.setRequestHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
xhr.setRequestHeader("Cookie", "SOME_STRING_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.post("http://undefinedundefined/v1/s3_encryption/set")
  .header("X-XSRF-TOKEN", "SOME_STRING_VALUE")
  .header("Cookie", "SOME_STRING_VALUE")
  .asString();

import Foundation

let headers = [
  "X-XSRF-TOKEN": "SOME_STRING_VALUE",
  "Cookie": "SOME_STRING_VALUE"
]

let request = NSMutableURLRequest(url: NSURL(string: "http://undefinedundefined/v1/s3_encryption/set")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://undefinedundefined/v1/s3_encryption/set",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Cookie: SOME_STRING_VALUE",
    "X-XSRF-TOKEN: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://undefinedundefined/v1/s3_encryption/set");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-XSRF-TOKEN: SOME_STRING_VALUE");
headers = curl_slist_append(headers, "Cookie: SOME_STRING_VALUE");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("http://undefinedundefined/v1/s3_encryption/set");
var request = new RestRequest(Method.POST);
request.AddHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
request.AddHeader("Cookie", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

Body parameters

required

*/*

encryptionModestring (Enum)

Allowed values:"DISABLED""INTERNAL""EXTERNAL"

REQUEST
[*/* content]

Responses

successful operation

Body

application/json

encryptionModestring (Enum)

Allowed values:"DISABLED""INTERNAL""EXTERNAL"

RESPONSE
{
  "encryptionMode": "DISABLED"
}

Access was denied due to invalid credentials.

The specified HTTP method is not allowed. Please resend the request using the POST method.

The key management system has not been set up.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{
  "code": "example",
  "message": "example",
  "details": "example"
}