...
Use Cases for Triggering Snapshots Automatically
It’s easy enough to go to a Confluence page and click “Take New Snapshot”, but that requires a manual, human, action.
...
The following two parameters are required, and are unique for each Jira Snapshot macro:
A MACRO-SPECIFIC-UELURL
An API-KEY.
Retrieve these parameters from the macro configuration window, on the “Automation tab”
...
Once enabled, the macro SAVE the macro configuration to make this change effective. Copy the API Key- as there is only one opportunity to do that. If you loose the API Key you’ll need to regenerate a new one. The API Key itself is not saved by Jira Snapshot and hence cannot be retrieved again.
Once enabled, SAVE the macro configuration to make this change effective.
This is the REST CALL syntax to trigger a new Snapshot for an existing, configured, Jira Snapshot macro:
...
jira-snapshots-api-key: <API-KEY>
Here is how it looks with a curl call/on CURL:
| Code Block | ||
|---|---|---|
| ||
curl --location --request POST '<MACRO-SPECIFIC-URL>' \ --header 'jira-snapshots-api-key: <API-KEY>' |
...
To remove the possibility for all existing automation to trigger one of the Snapshot macros, you may:
Regenerate the API Key. This will make all existing automation automations invalid (until they are updated with the new key).
Disable the automation for this specific macro.
...
A Confluence administrator can also revoke all enabled automations.
...