Archiving
Create Archive Configuration
Use this method to configure archiving for an instance. Only one archiving configuration may exist at any time.
Permissions
| Resource | Permission | Usage |
|---|---|---|
archiving | write | Lets you switch archiving on and point it at your own storage bucket |
POST
/
v1
/
config
/
archiving
Create Archive Configuration
curl --request POST \
--url https://api.mezmo.com/v1/config/archiving \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}
'import requests
url = "https://api.mezmo.com/v1/config/archiving"
payload = {
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integration: '<string>',
bucket: '<string>',
endpoint: '<string>',
apikey: '<string>',
resourceinstanceid: '<string>',
accountname: '<string>',
accountkey: '<string>',
projectid: '<string>',
space: '<string>',
accesskey: '<string>',
secretkey: '<string>',
authurl: '<string>',
expires: '<string>',
username: '<string>',
password: '<string>',
tenantname: '<string>'
})
};
fetch('https://api.mezmo.com/v1/config/archiving', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mezmo.com/v1/config/archiving",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration' => '<string>',
'bucket' => '<string>',
'endpoint' => '<string>',
'apikey' => '<string>',
'resourceinstanceid' => '<string>',
'accountname' => '<string>',
'accountkey' => '<string>',
'projectid' => '<string>',
'space' => '<string>',
'accesskey' => '<string>',
'secretkey' => '<string>',
'authurl' => '<string>',
'expires' => '<string>',
'username' => '<string>',
'password' => '<string>',
'tenantname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mezmo.com/v1/config/archiving"
payload := strings.NewReader("{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mezmo.com/v1/config/archiving")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mezmo.com/v1/config/archiving")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}Authorizations
Body
application/json
Request parameters
Response
OK
Was this page helpful?
Create Archive Configuration
curl --request POST \
--url https://api.mezmo.com/v1/config/archiving \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}
'import requests
url = "https://api.mezmo.com/v1/config/archiving"
payload = {
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integration: '<string>',
bucket: '<string>',
endpoint: '<string>',
apikey: '<string>',
resourceinstanceid: '<string>',
accountname: '<string>',
accountkey: '<string>',
projectid: '<string>',
space: '<string>',
accesskey: '<string>',
secretkey: '<string>',
authurl: '<string>',
expires: '<string>',
username: '<string>',
password: '<string>',
tenantname: '<string>'
})
};
fetch('https://api.mezmo.com/v1/config/archiving', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mezmo.com/v1/config/archiving",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration' => '<string>',
'bucket' => '<string>',
'endpoint' => '<string>',
'apikey' => '<string>',
'resourceinstanceid' => '<string>',
'accountname' => '<string>',
'accountkey' => '<string>',
'projectid' => '<string>',
'space' => '<string>',
'accesskey' => '<string>',
'secretkey' => '<string>',
'authurl' => '<string>',
'expires' => '<string>',
'username' => '<string>',
'password' => '<string>',
'tenantname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mezmo.com/v1/config/archiving"
payload := strings.NewReader("{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mezmo.com/v1/config/archiving")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mezmo.com/v1/config/archiving")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration\": \"<string>\",\n \"bucket\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"apikey\": \"<string>\",\n \"resourceinstanceid\": \"<string>\",\n \"accountname\": \"<string>\",\n \"accountkey\": \"<string>\",\n \"projectid\": \"<string>\",\n \"space\": \"<string>\",\n \"accesskey\": \"<string>\",\n \"secretkey\": \"<string>\",\n \"authurl\": \"<string>\",\n \"expires\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"tenantname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"integration": "<string>",
"bucket": "<string>",
"endpoint": "<string>",
"apikey": "<string>",
"resourceinstanceid": "<string>",
"accountname": "<string>",
"accountkey": "<string>",
"projectid": "<string>",
"space": "<string>",
"accesskey": "<string>",
"secretkey": "<string>",
"authurl": "<string>",
"expires": "<string>",
"username": "<string>",
"password": "<string>",
"tenantname": "<string>"
}{
"code": "<string>",
"error": "<string>"
}{
"code": "<string>",
"error": "<string>"
}
