Skip to main content

Stop Clore Agent on a Machine

Endpoint Description​

POST /clore/v1/machines/agents/stop

This endpoint stops the Clore Agent on a specified machine. It requires authentication and specific user roles to access. The request must include the deployment ID to identify the running instance of the Clore Agent that needs to be stopped.

Request Body Description​

The request body for stopping the Clore Agent must be a JSON object containing the following field:

Fields​

  • deployment_id: string
    • The unique identifier for the deployment of the Clore Agent that needs to be stopped.

Example Request Body​

{
  "deployment_id": "a1b2c3d4-5678-90ef-ghij-klmnopqrstuv"
}

Success Response​

Status Code: 200 OK

Response Body Description​

The response body contains information about the task initiated to stop the Clore Agent.

Fields​

  • task_id: string
    • The unique identifier for the task associated with stopping the Clore Agent.

Example Response Body​

{
  "task_id": "w1x2y3z4-5678-90ab-cdef-ghijklmnopqr"
}

HTTP Status Codes​

The "Stop Clore Agent" endpoint may return the following HTTP status codes based on the outcome of the request:

  • 200 OK: The request was successful, and the response body contains the task identifier.
  • 400 Bad Request: The server could not understand the request due to invalid syntax. This status is typically returned if required fields are missing or incorrectly formatted.
  • 401 Unauthorized: The request lacks valid authentication credentials for the target resource. This status indicates that the client must authenticate themselves to get the requested response.
  • 403 Forbidden: The server understood the request but refuses to authorize it. This typically means the requester doesn't have the required roles to access the resource.
  • 404 Not Found: The requested resource could not be found. This status may be returned if the deployment ID is incorrect.
  • 500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request. This is a generic error message when no specific message is suitable.

Example cURL Request​

curl -X POST "https://api.hiveon.ai/clore/v1/machines/agents/stop" \
     -H "Content-Type: application/json" \
     -d '{
           "deployment_id": "a1b2c3d4-5678-90ef-ghij-klmnopqrstuv"
         }'

This cURL command stops the Clore Agent on a specified machine, using the provided deployment ID.