Skip to main content

License

Get license​

Request​

Definition​

GET /api/v1/license

Headers​

  • Authorization required

    Authentication token with privileges to view the resource.

    Bearer {token}

Response​

Status codes​

Status codeMessage
200"License info"
403"Forbidden"

Body​

  • data.license.created string

    Date and time the licence was created.

  • data.license.customer_name string

    Name of the organisation on whose behalf the licence is granted.

  • data.license.delay_expiry_days integer

    Number of days remaining until the licence expires.

  • data.license.delay_max_uses_perc integer

    Number of monthly requests over the limit before monitoring is stopped.

  • data.license.entitlements object

    Object that contains all software services and indicates whether the instance is enabled to use them.

  • data.license.expiry string

    Date and time when the licence expires.

  • data.license.id string

    License ID.

  • data.license.key string

    Represents the licence key.

  • data.license.last_validated string

    Date and time the licence was last validated.

  • data.license.max_machines integer

    Maximum number of computers on which the software instance can be used.

  • data.license.ordered_entitlements_keys array<string>

    List of all software services in alphabetical order.

  • data.license.policy string

    Policy associated to the license.

  • data.license.status string

    Indicates the status of the licence.

  • data.license.suspended boolean

    Indicates if the licence has been suspended.

  • data.license.updated string

    Date and time the licence was last modified.

  • data.monthly_tx_counter integer

    How many transactions were analysed during the month.

  • data.monthly_tx_limit_reached boolean

    Indicates if the monthly limit of analysed transactions has been reached.

Insert license key​

Request​

Definition​

POST /api/v1/license

Headers​

  • Authorization required

    An authentication token with privileges to view the resource.

    Bearer {token}

  • Content-Type required

    application/json

Request body​

{
  "license_key": "72xC94-xxxxx-278x8B-528A45-xxxxx-Vx"
}

Response​

Status codes​

Status codeMessage
200"License succesfully inserted"
400"Error inserting license key"
403"Forbidden"

Body​

{
  "data": {
    "license": {
      "created": "2023-11-17T09:20:30.783Z",
      "customer_name": "Test License",
      "delay_expiry_days": 10,
      "delay_max_uses_perc": 10,
      "entitlements": {
        "application_rules": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Protection - Application rules"
        },
        "audit_logs": {
          "is_limited": false,
          "max_uses": "null",
          "name": "Audit logs"
        },
        "detection_bac": {
          "is_limited": false,
          "max_uses": null,
          "name": "Detection - Broken Access Control"
        },
        "detection_iaaf": {
          "is_limited": false,
          "max_uses": null,
          "name": "Detection - Brute Force & Bot"
        },
        "detection_inj": {
          "is_limited": false,
          "max_uses": null,
          "name": "Detection - Injection"
        },
        "metrics_storage": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Metrics storage"
        },
        "monitored_hosts": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Monitored hosts"
        },
        "monitored_monthly_requests": {
          "is_limited": true,
          "max_uses": 900,
          "name": "Monitored monthly requests"
        },
        "network_rules": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Protection - Network rules"
        },
        "notification": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Notification"
        },
        "reports": {
          "is_limited": false,
          "max_uses": null,
          "name": "Reports"
        },
        "rules_automation": {
          "is_limited": false,
          "max_uses": null,
          "name": "Rules automation"
        },
        "traffic_storage": {
          "is_limited": true,
          "max_uses": "unlimited",
          "name": "Traffic storage"
        }
      },
      "expiry": "2040-01-16T09:20:30.785Z",
      "id": "xxxxx-1892-xxxx-a98e-xxxxxxxxxx",
      "last_validated": null,
      "max_machines": 1,
      "ordered_entitlements_keys": [
        "monitored_monthly_requests",
        "monitored_hosts",
        "detection_inj",
        "detection_bac",
        "detection_iaaf",
        "traffic_storage",
        "metrics_storage",
        "network_rules",
        "application_rules",
        "notification",
        "rules_automation",
        "audit_logs",
        "reports"
      ],
      "policy": null,
      "status": "active",
      "suspended": false,
      "updated": "2023-12-05T09:52:08.473Z",
    },
    "monthly_tx_counter": 0,
    "monthly_tx_limit_reached": false,
    "status": "active"
  },
  "message": "License succesfully inserted",
  "status": "ok"
}