Enable BitNinja License

POST

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

curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/license/bitninja/{vm_id}/lb/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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.

Parameters

Path Parameters

vm_id

required

integer

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

Example

23456

Query Parameters

project_id

required

integer

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

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request

Example

<API_KEY>

location

required

string

Region of the load balancer.

Example

<LOCATION>

Request Body

Media typeapplication/json

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

object

Example ^generated

{}

Responses

200

Successful response

Media typeapplication/json

object

code

integer

data

object

command_to_execute

Shell command to install the BitNinja agent on the appliance.

string

errors

object

message

string

Example

{
  "code": 200,
  "data": {
    "command_to_execute": "curl https://get.bitninja.io/install.sh | /bin/bash -s - --license_key=<rsk_secret>"
  },
  "message": "Success"
}