Skip to main content

Install a Marketplace Tool

Installs a marketplace tool on the cluster. The path takes the cluster service_id and the tool_id (a tool id from Marketplace). The request body is empty. Installation runs asynchronously - poll Marketplace for the tool's status.

POST/api/v1/kubernetes/cluster-tool-action/{service_id}/tool/{tool_id}/

Path parameters

  • service_idPathintegerrequired

    The cluster service_id, as returned by List.

    • required
    • must be a valid cluster service ID
    example12345
  • tool_idPathintegerrequired

    The id of the tool to install (from Marketplace).

    • required
    • must be a valid tool ID
    example1

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Installing a tool takes an empty request body; the tool is chosen via the tool_id path parameter.

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
examplePlease Wait, Monitoring Stack is Installing!