Fortinet black logo

GET

Copy Link
Copy Doc ID 7e3e6f9e-a082-11ee-8673-fa163e15d75b:670556
Download PDF

GET

URI:
  • /api/v1/count?resource=***
Input fields:
Field Name Type Required

Description

resource

string

Yes

Resources such as

  • user
  • realm
  • device
  • client
  • SMS

  • realm_quota

realm_id string No The realm ID.
Successful response fields:
Field name Type Description
[specific resource] integer The remaining available resource count.
quota integer The total allowed resource count.
Response codes:
Code

Response content

Description
200 OK Resource count has been returned.
400 Bad Request
  • Cannot find customer info.

  • The requested resource does not exist .

403 Forbidden
  • Realm ID required for getting realm quota info.

  • Only global admin can get the device count.

Example request body:
None
Example of successful response body:
{
   "user": 120,
   "quota": 1200000
}

GET

URI:
  • /api/v1/count?resource=***
Input fields:
Field Name Type Required

Description

resource

string

Yes

Resources such as

  • user
  • realm
  • device
  • client
  • SMS

  • realm_quota

realm_id string No The realm ID.
Successful response fields:
Field name Type Description
[specific resource] integer The remaining available resource count.
quota integer The total allowed resource count.
Response codes:
Code

Response content

Description
200 OK Resource count has been returned.
400 Bad Request
  • Cannot find customer info.

  • The requested resource does not exist .

403 Forbidden
  • Realm ID required for getting realm quota info.

  • Only global admin can get the device count.

Example request body:
None
Example of successful response body:
{
   "user": 120,
   "quota": 1200000
}