Activating an unverified storage component

post /v1/storage_component/activate

Marks a defined storage component as ACTIVE, making it available to serve requests. Components are initially marked as UNVERIFIED until activated using this endpoint

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/storage_component/activate'
    
      -d
      '{
  "id" : 0
}'

import http.client

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

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

conn.request("POST", "/v1/storage_component/activate", headers=headers)

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

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

require 'uri'
require 'net/http'

url = URI("http://undefinedundefined/v1/storage_component/activate")

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/storage_component/activate");
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/storage_component/activate")
  .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/storage_component/activate")! 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/storage_component/activate",
  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/storage_component/activate");

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/storage_component/activate");
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

*/*

idintegerrequiredint32

Integer identifier for metadata.

REQUEST
[*/* content]

Responses

The storage component was successfully activated.

Body

application/json

idinteger

ID of the storage component

storageTypestring

Type of the storage component

Example:"AMAZON_S3"

verifiedboolean

If true, the storage component is activated. If false, it has not been verified and is awaiting for an administrative action.

httpStatusintegerint32

The HTTP status code the storage component responded with while attempting to test access to or activate the storage component. If it can't be reached the code would be 0. If it can be reached code can help explain why it can't be verified.

errorCodestring

Error codes associated with the component

errorMessagestring

Error messages associated with the component

daysUntilCertificateExpirationintegerint32

Number of days left before the current HTTPS certificate expires

statestring (Enum)

State of the storage component that indicates availability to server requests. When the component is ready for server requests, the status is ACTIVE. A PAUSED component is on an administrative pause. Accessibility issues caused by network, authentication, or certificates can cause the component to be INACCESSIBLE. A READ_ONLY component blocks all writes to data disks but allows reads. The component that has not been activated or failed to activate is UNVERIFIED. A component that is permanently unavailable for serving requests is DECOMMISSIONED.

Allowed values:"ACTIVE""PAUSED""INACCESSIBLE""READ_ONLY""UNVERIFIED""DECOMMISSIONED"

RESPONSE
{
  "id": 0,
  "storageType": "AMAZON_S3",
  "verified": false,
  "httpStatus": 0,
  "errorCode": "example",
  "errorMessage": "example",
  "daysUntilCertificateExpiration": 0,
  "state": "ACTIVE"
}

The MAPI Metadata Id is invalid.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

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

Access was denied due to invalid credentials.

The requested storage component was not found.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

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

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