Skip to main content
Version: Next

Clients Control

Available API Paths

/api/projects/{projectId}/brokers/{brokerId}/clients/{client}/disconnect​

The following methods are available for this path:

PUT​

Disconnects specified broker client

Parameters

NameLocationTypeDescription
projectIdpathstringA project id
brokerIdpathstringA broker id
clientpathstringA client name
Request Body

Name Location Type Description
body body object Properties:

{
  "clientId": {
    "type": "string",
    "description": "The unique client id"
  }
}
Responses

Status Description Response Content or Scheme
200 An empty object.
401 Unauthorized request error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
403 Request is not allowed error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
404 Resource is not found error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
405 Method not supported for this resource 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}
500 Internal server error 
{
  "message": {
    "type": "string",
    "description": "A descriptive error message"
  },
  "code": {
    "type": "string",
    "description": "A textual error code"
  },
  "status": {
    "type": "integer",
    "description": "A corresponding HTML status code"
  },
  "info": {
    "type": "object",
    "description": "An optional info object containing error dependent information"
  }
}