License Stats

GET 
/api/v32.04/stats/license

x-prisma-cloud-target-env: {"permission":"systemOperations","saas":true,"self-hosted":true}
x-public: true

LicenseStats returns the license stats including the credit per defender

Responses

200

LicenseStats holds the console license stats

application/json

Schema

Schema

avg double

Avg is the average number of credits.

containerDefenders integer

ContainerDefenders is the total number of container defenders.

dailySamplesDefenders double[]

DailySamplesDefenders holds the last 30 daily credits averages.

exceeded boolean

Exceeded indicates the number of credits exceeded license.

hostDefenders integer

HostDefenders is the total number of host defenders.

hourAvg double

HourAvg is the average number of credits per hour.

hourSamples double

HourSamples is the number of hourly samples collected.

monthlyUsage object[]
MonthlyUsage holds the last 24 monthly usage averages.
Array [
appEmbedded object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
container object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
containerAgentless object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
host object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
hostAgentless object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
period date-time
Period is the date beginning of the usage period.
remainingCredits integer
RemainingCredits is the amount of credits left at the beginning of the period.
serverless object
ServerlessUsage holds the number of defenders, invocations and credits used for serverless defenders
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
protectedFunctions double
ProtectedFunctions is the number of serverless functions that have a defender installed.
scannedFunctions double
ScannedFunctions is the number functions being scanned for vulnerabilities and compliance issues without a defender installed.
waas object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
waasOutOfBand object
DefenderUsage holds the number of defenders and the credits used for a specific defender type
creditCount double
CreditCount is credits that was used for this defender type.
defendersCount double
DefendersCount is the number of defenders that was used for this defender type.
]
msg string

Msg is the license exceeded error/warning message to show.

onDemandCredits integer

OnDemandCredits is the number of on demand credits used during the current contract.

protectedFunctions double

ProtectedFunctions is the number of serverless functions that have a defender installed.

scannedFunctions double

ScannedFunctions is the number functions being scanned for vulnerabilities and compliance issues without a defender installed.

serverlessTimestamp date-time

ServerlessTimestamp is the timestamp for the last serverless credit calculation.

timestamp date-time

Timestamp is the last collection timestamp.

totalCreditUsage integer

TotalCreditUsage is the total amount of credits used from the beginning of the current contract.

Example (from schema)

{
  "avg": 0,
  "containerDefenders": 0,
  "dailySamplesDefenders": [
    0
  ],
  "exceeded": true,
  "hostDefenders": 0,
  "hourAvg": 0,
  "hourSamples": 0,
  "monthlyUsage": [
    {
      "appEmbedded": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "container": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "containerAgentless": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "host": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "hostAgentless": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "period": "2024-04-23T19:45:39.523Z",
      "remainingCredits": 0,
      "serverless": {
        "creditCount": 0,
        "defendersCount": 0,
        "protectedFunctions": 0,
        "scannedFunctions": 0
      },
      "waas": {
        "creditCount": 0,
        "defendersCount": 0
      },
      "waasOutOfBand": {
        "creditCount": 0,
        "defendersCount": 0
      }
    }
  ],
  "msg": "string",
  "onDemandCredits": 0,
  "protectedFunctions": 0,
  "scannedFunctions": 0,
  "serverlessTimestamp": "2024-04-23T19:45:39.523Z",
  "timestamp": "2024-04-23T19:45:39.523Z",
  "totalCreditUsage": 0
}

default

Loading...