Create Archive Configuration

Use this method to configure archiving for an instance. Only one archiving configuration may exist at any time.

POST /v1/config/archiving

Create Archive Configuration

cURL

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>"
}
'

200

{
  "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>"
}

Authorizations

AccessTokenservicekeyAuth

Authorization · string · header · required

This key is used for all apis with the exception of ingest. You can obtain it following these instructions and placing the key in the header of your call in the format of Authorization: Token {accesstoken} For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

Body

application/json

Request parameters

integration · string

Defines the type of notification channel. Valid values are: email, webhook, slack, and pagerduty

bucket · string

Name of the bucket.

endpoint · string

Private endpoint associated with the bucket.

apikey · string

API key that is needed to authenticate with the Cloud Object Storage service.

resourceinstanceid · string

CRN of the Cloud Object Storage instance ID where the bucket is available.

accountname · string

Account name

accountkey · string

Account key

projectid · string

Project ID

space · string

Space

accesskey · string

Access key

secretkey · string

Secret key

authurl · string

Auth URL

expires · string

Expires

username · string

Username

password · string<password>

Password provided in credentials for authorization

tenantname · string

Tenant name

Response

200

application/json

OK

integration · string

Defines the type of notification channel. Valid values are: email, webhook, slack, and pagerduty

bucket · string

Name of the bucket.

endpoint · string

Private endpoint associated with the bucket.

apikey · string

API key that is needed to authenticate with the Cloud Object Storage service.

resourceinstanceid · string

CRN of the Cloud Object Storage instance ID where the bucket is available.

accountname · string

Account name

accountkey · string

Account key

projectid · string

Project ID

space · string

Space

accesskey · string

Access key

secretkey · string

Secret key

authurl · string

Auth URL

expires · string

Expires

username · string

Username

password · string<password>

Password provided in credentials for authorization

tenantname · string

Tenant name