API Overview Tab
The API Overview tab displays the basic information for the API in question:

Field No. | Field Name | Editable | Description |
---|---|---|---|
1 |
Edit |
N/A |
Clicking this enables the user to edit some of the fields presented in the Overview tab. Only fields marked as editable in this table are able to be edited. |
2 |
Delete |
N/A |
Only user accounts with associated Administrator priveleges will see this option. Clicking this enables API assets to be deleted. For more details, refer to: Deleting API Assets. |
3a |
API Name |
Yes |
The name you have associated with this API. |
3b |
Primary Hostname |
No |
The primary hostname for this API. |
3c |
WhiteHat Asset ID |
No |
The unique asset ID associated with this API by WhiteHat Security |
3d |
Custom Asset ID |
Yes |
This is used if you have an asset ID you wish to associate with the API. |
3e |
Asset Owner |
Yes |
The Sentinel user who is assigned as the owner of this API. |
3f |
Asset Status |
Yes |
An asset may be active or inactive. |
3g |
Asset Phase |
Yes |
The Asset Phase may be pre-production, production, discontinued, or none. |
3h |
Client Name |
No |
Customers with multiple clients on their account can assign an asset to a specific client. |
3i |
Industy |
Yes |
This is required so that the Peer Benchmarking Dashboard provides information relevant to your company and its industry. |
3j |
API Description |
Yes |
This is a free text field for any information that you may have about your API. |
3k |
Service Level |
No |
This will indicate whether this API is using a BE license, an SE license, or a PE license. For additional information on service levels, please click here. |
3l |
Service Type |
No |
Indicates the service type of this API. |
3m |
Website Is |
No |
Indicates if this API is available externally, or is an internal-only API. |
3n |
Uses Satellite |
No |
Indicates whether or not this API uses a satellite appliance. |
3o |
Satellite Name |
Yes |
The name of the satellite used by this API, if any. |
3p |
Satellite Status |
No |
The connection status of the appliance used by this API, if any. |
3q |
Users with Access |
No |
A link to a list of users who have permissions for this API in Sentinel. |
3r |
Timezone |
No |
The time zone associated with the API. Note that this affects the scan schedule; scanning scheduled for particular hours will begin and end based on this time zone. |
3s |
Service Renewal Date |
No |
Renewal date for this license. |
3t |
Security Index |
No |
The WhiteHat Security Index score for this API (available for the Advanced Rating Methodology only). |
3u |
Global |
No |
The WhiteHat Security Index score for this API (available for the Advanced Rating Methodology only), in comparison to all other APIs. |
3v |
Industry |
No |
The WhiteHat Security Index score for this API (available for the Advanced Rating Methodology only), in comparison to other APIs in the indicated industry. |
3w |
Priority |
Yes |
The priority rank that you have associated with this API, if any. |