Skip to content

Commit 796962d

Browse files
Backups API update for optional comment
Update backups API documentation for optional comment
2 parents d5ed1de + 7323c8a commit 796962d

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

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

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,11 @@ A JSON object with the following attributes:
171171

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

174-
**Example Request**
174+
{{% alert color="info" %}}
175+
The `comment` attribute is optional, but the API requires an empty JSON object (`{}`) to return a successful response.
176+
{{% /alert %}}
177+
178+
**Example Request 1**
175179

176180
```bash
177181
POST /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots
@@ -180,10 +184,19 @@ Host: deploy.mendix.com
180184
Content-Type: application/json
181185
Mendix-Username: richard.ford51@example.com
182186
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
187+
{"comment": "My snapshot"}
188+
```
183189

184-
{
185-
"comment" : "My snapshot"
186-
}
190+
**Example Request 2**
191+
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+
{}
187200
```
188201

189202
#### Output

0 commit comments

Comments
 (0)