usage

Usage service handles licencing

getUsage usage

Retrieve a single usage

Securityx-api-key
Request
path Parameters
metric
required
string

Usage metric

Example: Ut non voluptas accusamus est.
query Parameters
accountIdentifier
required
string

Account identifier

Example: accountIdentifier=Eveniet aliquid et qui.
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

put/iacm/api/enforcement/client/usage/{metric}
Request samples
Response samples
application/json
{
  • "data": {
    },
  • "status": "Quidem itaque accusamus."
}

checkLicence usage

Check whether the account is currently licenced

Securityx-api-key
Request
header Parameters
Harness-Account
required
string

Account identifier

Example: Dolor nisi.
Responses
200

OK response.

400

BadRequestError: Bad Request response.

401

UnauthorizedError: Unauthorized response.

403

ForbiddenError: Forbidden response.

404

NotFoundError: Not Found response.

408

TimeoutError: Request Timeout response.

409

ConflictError: Conflict response.

423

LockedError: Locked response.

499

ContextCancelledError: response.

500

InternalServerError: Internal Server Error response.

502

BadGatewayError: Bad Gateway response.

get/iacm/api/usage/check-licence
Request samples
Response samples
application/json
{
  • "account": "9",
  • "isLicenced": true,
  • "isPaid": true,
  • "reason": "Aut sit quo.",
  • "startTime": 3320797572868542500,
  • "total": 5708241253533765000,
  • "used": 6975405125300041000
}