Skip to main content

Activate Bitninja

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

Path parameters

  • vm_idPathstringrequired

    Path parameter vm_id.

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authenticate the Activate Bitninja request

    • required
    • must be a valid API key
    example{{api_key}}
  • locationQuerystringoptional

    Specifies the target location for the activation request.

    • must be a non-empty string
    • may contain only letters, numbers, hyphens, or underscores
    example{{location}}

Request body

application/json

object

Responses

200Successful response
object
codeinteger

HTTP status code of the activation response

example200
  • integer
  • value between 100 and 599
dataobject
errorsobject
messagestring

Status message indicating the result of the activation request

exampleSuccess
  • non-empty string
  • max length 100 characters