Cluster Application Force Restart

Forces a cluster application to restart.

Request

Property	Value
Method	`POST`
URL	`/api/cluster/applications/{appId}/command`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/cluster/applications/{appId}/command" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data":{"attributes":{"command":"forceRestart"}}}'

Path Parameters

Parameter	Type	Required	Description
`appId`	string	Yes	Application ID

Request With Parameters

bash

curl -X POST "{BASE_URL}/api/cluster/applications/{appId}/command" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.command`	string	Yes	Command to execute (always `"forceRestart"`)

Request Body

json

{
  "data": {
    "attributes": {
      "command": "forceRestart"
    }
  }
}

Response Body

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)
`message`	string	Response status message

Successful Response (200)

json

{
  "meta": {
    "executionTime": 27,
    "generatedAt": 1767789946006
  },
  "message": "Application has been force restarted"
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Application Not Found (404)

json

{
  "message": "Application not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.