/v1/enterprise/allocation

Prev Next
Get
/v1/enterprise/allocation

Get all allocation for the given enterprise on a given month

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Responses
200

OK

Expand All
object
consumptionSummary
object (manaV2BandwidthConsumptionSummary)
contractualSummary
object (manaV2ContractualBandwidthConsumptionSummary)
expirationDate
object (manaV2TimePeriod)
month
integer (int32)
Example123
year
integer (int32)
Example123
totalConsumedCredits
number (float)

All credits consumed over the entirety the enterprise's contracts

Example12.34
totalContractedCredits
number (float)

Number of credits agreed upon for the entirety of the current contract

Example12.34
totalRemainingCredits
number (float)

Number of unused credits remaining under the current contract

Example12.34
globalSummary
object (manaV2GlobalBandwidthConsumptionSummary)
allocatedMonthlyCredits
number (float)

Credits allocated for the current month

Example12.34
consumedMonthlyCredits
number (float)

Credits billed for the current month. It equals the the higher value between the credits allocated and used for the month

Example12.34
priorAllocatedMonthlyCredits
number (float)

Credits allocated for the prior month

Example12.34
priorConsumedMonthlyCredits
number (float)

Credits billed for the prior month.

Example12.34
recommendedMonthlyCredits
number (float)

Expected amount of credits to allocate for the month to match the overall contracted amount. For monthly-contracted enterprises, this is equivalent to the monthly number of credits being billed while for term-based-contracted enterprises, this is equivalent to the number of credits to use up in this and the following months to use up exactly the number of credits remaining in the contract.

Example12.34
regionalSummaries
object
property*
object (manaV2RegionalBandwidthConsumptionSummary) additionalProperties
allocation
object (manaV2BandwidthInfo)
combinedCredits
number (float)

Sum of the credits associated with cloud and gateway networks

Example12.34
coreBandwidth
number (float)

Soft-upper-bounded max speed in gigabytes per second associated with core network connections

Example12.34
coreCredits
number (float)

Credits derived from bandwidth on core network connections

Example12.34
gwBandwidth
number (float)

Soft-upper-bounded max speed in gigabytes per second associated with gateway connections

Example12.34
gwCredits
number (float)

Credits derived from bandwidth on gateway network connections

Example12.34
consumedCredits
number (float)

Credits billed for the region. It equals the higher value between total credits allocated and used plus any additional dia consumption

Example12.34
coreConversionFactor
number (float)

Conversion rate from gigabytes per second to Graphiant credits used for calculating credits on core networks for this region

Example12.34
gwConversionFactor
number (float)

Conversion rate from gigabytes per second to Graphiant credits used for calculating credits on core networks for this region

Example12.34
internetConsumption
object (manaV2InternetAccessBandwidthInfo)
internetBandwidth
number (float)

Bandwidth value associated with dia gateways. This should either be 0, 10, or 100.

Example12.34
internetCredits
number (float)

Additional credits to support the provided DIA bandwidth

Example12.34
usage
object (manaV2BandwidthInfo)
combinedCredits
number (float)

Sum of the credits associated with cloud and gateway networks

Example12.34
coreBandwidth
number (float)

Soft-upper-bounded max speed in gigabytes per second associated with core network connections

Example12.34
coreCredits
number (float)

Credits derived from bandwidth on core network connections

Example12.34
gwBandwidth
number (float)

Soft-upper-bounded max speed in gigabytes per second associated with gateway connections

Example12.34
gwCredits
number (float)

Credits derived from bandwidth on gateway network connections

Example12.34
conversionHolders
object
property*
object (manaV2AllocationConversionHolder) additionalProperties
bins
Array of object (manaV2AllocationConversionHolderBin)
object
allocationUpperBound
number (float)

Int32 value indicating the conversion rates apply from the prior highest upper bound to this upper bound

Example12.34
coreConversionFactor
number (float)

Conversion rate from gigabytes per second to Graphiant credits for connections to core devices

Example12.34
coreConversionRate
integer (int32)
Example123
gwConversionFactor
number (float)

Conversion rate from gigabytes per second to Graphiant credits for connections to gateway devices

Example12.34
gwConversionRate
integer (int32)
Example123
isPrivate
boolean

True-only flag indicating the conversion rates apply within a private context such as in-country

Exampletrue
regionalAllocations
Array of object (manaV2RegionalAllocation)
object
allocationCore
number (float)

Gigabytes per second allowed for core network connections on this region

Example12.34
allocationGw
number (float)

Gigabytes per second allowed for gateway connections on this region

Example12.34
allocationInternet
number (float)

Gigabytes per second allowed for dia gateway internet access on this region. Must be 0, 10, or 100

Example12.34
creditCore
number (float)
Example12.34
creditGw
number (float)
Example12.34
regionId
integer (int32)
Example123
regionName
string
Exampleexample string
zeroTrustSummary
object (manaV2ZeroTrustConsumptionSummary)
userAgentCredits
number (float)

Number of devices that have been installed with the zero trust agent

Example12.34