Skip to content

Commit 61e668f

Browse files
Update backups API documentation for optional comment
Clarified that the comment attribute is optional and specified that an empty JSON object is needed for a successful response.
1 parent d5ed1de commit 61e668f

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,9 @@ A JSON object with the following attributes:
171171

172172
* `comment` (String): Optional comment for this snapshot.
173173

174-
**Example Request**
174+
Please note that the comment attribute is optional, but the API expects an empty JSON Object for a successful response.
175+
176+
**Example Requests**
175177

176178
```bash
177179
POST /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots
@@ -181,10 +183,23 @@ Content-Type: application/json
181183
Mendix-Username: richard.ford51@example.com
182184
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
183185

186+
Request-Body:
184187
{
185188
"comment" : "My snapshot"
186189
}
187190
```
191+
Or,
192+
```bash
193+
POST /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots
194+
Host: deploy.mendix.com
195+
196+
Content-Type: application/json
197+
Mendix-Username: richard.ford51@example.com
198+
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
199+
200+
Request-Body:
201+
{}
202+
```
188203

189204
#### Output
190205

0 commit comments

Comments
 (0)