Problem

The exporting API documentation does not make it clear how to determine whether a pause/resume request succeeded or failed.

The HTTP status code is always 200. The actual result is in the status field of the JSON response body: 204 means success, 500 means failure. This is not documented in the management API docs, and is only visible inside a collapsed <details> block in the backup guide.

Additionally, the operation can fail entirely (no partitions are paused or resumed) if the cluster topology is temporarily incomplete — for example, when a broker is unavailable. This precondition is not documented.

Success response

{
  "body": null,
  "status": 204,
  "contentType": null
}

Failure response

{
  "body": {
    "message": "Expected 3 members of partition 1 but found 2, current topology: ..."
  },
  "status": 500,
  "contentType": null
}

Suggested changes

management-api.md (Exporting API section):

• Note that the HTTP status is always 200 and callers must check the status field in the response body (204 = success, 500 = failure)
• Add success and failure response examples
• Note that the operation fails entirely if the cluster topology is incomplete

backup.md:

• Make it more visible that callers should check the status field in the response body — this is currently hidden inside a collapsed details block and easy to miss

Links

• Support: #inc-support-32087-softpause-stuck-during-backup-causing-unhealthy-partition