Skip to main content
Version: Mosquitto 3.0

Topic Tree

Topic Tree operations

Available API Paths​

Path: /api/system/topictree​

Methods​

GET​

Returns the topic tree for all the brokers. Can be used only by a logged in user without any restricted roles

Responses

Status Description Response Content or Scheme
200 Map of broker names to their topic trees
403 User does not have enough permissions to access the resource 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_ALLOWED"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Not allowed"
    ],
    "description": "Message of the error"
  }
}
404 Plugin is not enabled or not found 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_FOUND"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Plugin not found"
    ],
    "description": "Message of the error"
  }
}
500 An internal server error has occured 
{
  "code": {
    "type": "string",
    "enum": [
      "SOMETHING_WRONG",
      "INTERNAL_ERROR"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "An internal server error occurred"
    ],
    "description": "Message of the error"
  }
}

DELETE​

Clears all the topic trees in MMC. Can be used only by a logged in user without any restricted roles

Responses

Status Description Response Content or Scheme
200
401 Access to resource is denied. User not authenticated (logged in) or session expired 
{
  "code": {
    "type": "string",
    "enum": [
      "UNAUTHORIZED"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Unauthorized"
    ],
    "description": "Message of the error"
  }
}
403 User does not have enough permissions to access the resource 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_ALLOWED"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Not allowed"
    ],
    "description": "Message of the error"
  }
}
404 Plugin is not enabled or not found 
{
  "code": {
    "type": "string",
    "enum": [
      "NOT_FOUND"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "Plugin not found"
    ],
    "description": "Message of the error"
  }
}
500 An internal server error has occured 
{
  "code": {
    "type": "string",
    "enum": [
      "SOMETHING_WRONG",
      "INTERNAL_ERROR"
    ],
    "description": "Name of the error"
  },
  "message": {
    "type": "string",
    "enum": [
      "An internal server error occurred"
    ],
    "description": "Message of the error"
  }
}