Create Archive Configuration

POST

https://api.mezmo.com/v1/config/archiving

POST

/v1/config/archiving

curl -X POST https://api.mezmo.com/v1/config/archiving \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "integration": "ibm_cos",
  "bucket": "payment-service-logs",
  "endpoint": "s3.us.cloud-object-storage.appdomain.cloud",
  "apikey": "a1b2c3d4e5f6g7h8i9j0klmnopqrstuv",
  "resourceinstanceid": "crn:v1:bluemix:public:cloud-object-storage:global:a/1234567890abcdef1234567890abcdef:bucket:payment-service-logs",
  "accountname": "acme-corp-logs",
  "accountkey": "XyZ123AbC456DeF789GhIjKlMnOpQrStUvWxYz",
  "projectid": "proj-9876543210abcdef",
  "space": "prod-logs-space",
  "accesskey": "AKIAIOSFODNN7EXAMPLE",
  "secretkey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "authurl": "https://iam.cloud.ibm.com/identity/token",
  "expires": "2025-12-31T23:59:59Z",
  "username": "log-archiver",
  "password": "S3cur3P@ssw0rd!",
  "tenantname": "acme-corp-tenant"
}

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

Authentication

Authorizationstring

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

servicekeystring

(Deprecated) This key is used for v1 and v2 apis with the exception of ingest. Service keys can be used by placing your service key in the Authorization header of your api call. NOTE Usage of the service key auth mechanism has been deprecated in favor of IAM Access Tokens. Service keys can no longer be created, but can still be used for v1 and v2 apis while the transition takes place

Request

Request parameters

integrationstringOptional

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

bucketstringOptional

Name of the bucket.

endpointstringOptional

Private endpoint associated with the bucket.

apikeystringOptional

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

resourceinstanceidstringOptional

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

accountnamestringOptional

Account name

accountkeystringOptional

Account key

projectidstringOptional

Project ID

spacestringOptional

Space

accesskeystringOptional

Access key

secretkeystringOptional

Secret key

authurlstringOptional

Auth URL

expiresstringOptional

Expires

usernamestringOptional

Username

passwordstringOptionalformat: "password"

Password provided in credentials for authorization

tenantnamestringOptional

Tenant name

Response