Skip to main content
Version: Mosquitto 3.1

Topic Tree

Available API Paths

/api/projects/{projectId}/brokers/{brokerId}/topictree​

The following methods are available for this path:

GET
Viewer
​

Get current topic-tree of specified broker

Parameters

NameLocationTypeDescription
projectIdpathstringA project id
brokerIdpathstringA broker id
offsetqueryintegerNumber of topics to skip. Set to 0 to start at the beginning.
countqueryintegerNumber of topics which should be returned. Set -1 for all entries.
Responses

Status Description Response Content or Scheme
200 The current topic tree. 
{
  "publishTopics": {
    "type": "object",
    "properties": {
      "count": {
        "type": "integer",
        "description": "Count of publish topics."
      },
      "topics": {
        "type": "array",
        "description": "Publish topics",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "subscribeTopics": {
    "type": "object",
    "properties": {
      "count": {
        "type": "integer",
        "description": "Count of publish topics."
      },
      "topics": {
        "type": "array",
        "description": "Publish topics",
        "items": {
          "type": "string"
        }
      }
    }
  }
}
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"
  }
}

/api/projects/{projectId}/brokers/{brokerId}/topictree/ttl​

The following methods are available for this path:

GET
Viewer
​

Get current topic TTL of specified broker

Parameters

NameLocationTypeDescription
projectIdpathstringA project id
brokerIdpathstringA broker id
Responses

Status Description Response Content or Scheme
200 The current topic TTL in seconds. 
{
  "ttl_sec": {
    "type": "integer",
    "description": "The TTL after which a topic is removed."
  }
}
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"
  }
}

PUT
Viewer
​

Set new topic TTL of specified broker

Parameters

NameLocationTypeDescription
projectIdpathstringA project id
brokerIdpathstringA broker id
Request Body

Name Location Type Description
body body object Properties:

{
  "ttl_sec": {
    "type": "integer",
    "description": "The new topic TTL to use in seconds."
  }
}
Responses

Status Description Response Content or Scheme
204
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"
  }
}