Skip to main content

Enable BitNinja License

Activates the BitNinja security license on the load balancer's underlying VM. BitNinja is an add-on, server-protection layer (billed separately - see can_support_bitninja / bitninja_cost in LB Plans). The path takes the vm_id of the load balancer's node (the node_detail.vm_id field from List Load Balancers), not the load balancer (appliance) ID. The response returns the install command_to_execute.

The request body is an empty JSON object.

POST/api/v1/license/bitninja/{vm_id}/lb/

Path parameters

  • vm_idPathintegerrequired

    The vm_id field from the node_detail object in the List Load Balancers response.

    • required
    • must be a valid VM ID
    example23456

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 load balancer.

    • must be a non-empty string
    example{{location}}

Request body

application/json

object

No fields are required - send an empty JSON object. The target is identified by the vm_id path parameter.

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess