Skip to content
Brokerium

Pause after the current step

POST
/api/v1/operations/{op}/pause
curl --request POST \
  --url http://localhost:8080/api/v1/operations/example/pause \
  --header 'X-Brokerium-Request: 1' \
  --cookie brokerium_session=<brokerium_session>

Role: operator.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
op
required
string

Header Parameters

Section titled “Header Parameters”
X-Brokerium-Request
required
string
Allowed value: 1

Required on every non-GET request.

Responses

Section titled “Responses”

200

Section titled “200”

The operation after the action.

Media typeapplication/json
object
id
string
clusterId
string
type
string
status
string
Allowed values: planned pending running paused succeeded failed cancelled
summary
string
params
object
plan
object
summary
string
warnings
Array<string>
irreversible
boolean
moves
Array<object>
object
topic
string
partition
integer
from
Array<integer>
to
Array<integer>
sizeBytes
integer format: int64
replicaMoves
integer
leaderChange
boolean
before
object
brokers
Array<object>
object
id
integer
rack
string
replicas
integer
leaders
integer
dataBytes
integer format: int64
bytesInPerSec
number
excluded
boolean
replicaSpread
integer
leaderSpread
integer
dataSpreadBytes
integer format: int64
score
number
after
object
brokers
Array<object>
object
id
integer
rack
string
replicas
integer
leaders
integer
dataBytes
integer format: int64
bytesInPerSec
number
excluded
boolean
replicaSpread
integer
leaderSpread
integer
dataSpreadBytes
integer format: int64
score
number
dataToMoveBytes
integer format: int64
details
object
irreversible
boolean
currentStep
integer
requestedAction
string
error
string
createdBy
string
createdAt
string format: date-time
startedAt
string | null format: date-time
finishedAt
string | null format: date-time
updatedAt
string format: date-time
steps
Array<object>
object
index
integer
name
string
kind
string
args
alwaysRun
boolean
status
string
Allowed values: pending running succeeded failed skipped
detail
error
string
startedAt
string | null format: date-time
finishedAt
string | null format: date-time

Example 

{
  "status": "planned",
  "steps": [
    {
      "status": "pending"
    }
  ]
}

409

Section titled “409”

Error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.