Notifications

44 views

This endpoint allows creating a snapshot for the pending data of a given config data set. Optionally you can provide a comment which will be displayed in the snapshot history page.

The user must have the permissions on the config data set name to create a snapshot for the given validity level.

Endpoint

method
POST
URI
/api/v1/data/include/snapshot/byname

headers

!
Authorization
Bearer <userToken or APIkey>

Parameters

!
level
off | warning | error
"off" means that only a snapshot will be taken in case there are no warnings or errors for the pending data.
!
name
myMdsName
the exact name of the config data set for which a snapshot should be taken

description
my%20automated%20snapshot
URL encoded description on why the snapshot was taken

tag
myTag
a single string as TAG for that snapshot - cannot contain spaces. ex "release1.2.3"

Response

The response is a JSON containing the version details of the snapshot. In case of insufficient permissions, the response object will contain a {"access denied"} message

Example cURL

curl -s -X POST -H 'authorization: Bearer 'b33e48b3-c88d-45bf-9b3a-5e449b1b37d4 https://demo.sweagle.com'/api/v1/data/include/snapshot/byname?name='test01'&level=off&description=major%20build%20createdFor%20test%20purposes'

Article Information

Last Updated:2020-10-15 01:10:34
Published:2020-10-15