Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The suites resource returns a list of all suites that administrators can use to generate health check reports for their organization. Each suite is a grouping of predefined tests that are performed against the organization during a health check. The basic health check report conducts a suite of functional and availability health checks to validate overall organization health. Introduced at ArcGIS Enterprise on Kubernetes 12.0, the operational health check report provides insights into operational efficiency and the early detection of potential issues across multiple areas of Enterprise.
Along with the list of suites, this resource returns the tests included in each suite that will be performed during a health check, as well as the suite's ID, which is used to run a health check.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the suites resource:
https://organization.example.com/<context>/admin/healthCheck/suites?f=pjsonJSON Response example
{
"userSuites": [
{
"maintenanceTests": [],
"systemOnly": false,
"operationalTests": [],
"generalTests": [
{
"name": "healthcheck_relational_datastore",
"description": "Relational store health check"
},
{
"name": "healthcheck_object_store",
"description": "Object store health check"
},
{
"name": "home_app_availability",
"description": "ArcGIS Enterprise portal endpoint is available"
},
{
"name": "manager_availability",
"description": "ArcGIS Enterprise Manager endpoint is available"
},
{
"name": "healthcheck_spatiotemporal_index_store",
"description": "Spatio temporal and index store health check"
},
{
"name": "healthcheck_ingress",
"description": "Ingress health check"
},
{
"name": "healthcheck_publishingService",
"description": "System publishing tools health check"
},
{
"name": "healthcheck_sharedMapService",
"description": "Shared map services health check"
},
{
"name": "healthcheck_spatialanalysis",
"description": "Spatial analysis service health check"
},
{
"name": "healthcheck_geometryService",
"description": "Geometry service health check"
},
{
"name": "query_logs_availability",
"description": "Can query logs"
},
{
"name": "healthcheck_index_synced",
"description": "Users, groups, and items indices are in sync"
}
],
"name": "Basic health checks",
"description": "Conducts a suite of functional and availability health checks to validate overall organization health.",
"criticalTests": [{
"name": "sharing_availability",
"description": "Portal API endpoint is available"
}],
"id": "BSHC-001"
},
{
"maintenanceTests": [],
"systemOnly": false,
"operationalTests": [
{
"severity": "Critical",
"groupName": "High Availability",
"name": "high_availability_relational_store",
"description": "Architectural integrity of Relational store is sustained"
},
{
"severity": "Critical",
"groupName": "High Availability",
"name": "high_availability_object_store",
"description": "Architectural integrity of Object store is sustained"
},
{
"severity": "Critical",
"groupName": "High Availability",
"name": "high_availability_spatiotemporal_index_store",
"description": "Architectural integrity of Spatiotemporal and index store is sustained"
},
{
"severity": "Critical",
"groupName": "Backup",
"name": "backup_store_available",
"description": "An organizational backup store is available"
},
{
"severity": "Critical",
"groupName": "Backup",
"name": "backup_availability",
"description": "An organizational backup is available"
},
{
"severity": "Important",
"groupName": "Backup",
"name": "recent_backup_available",
"description": "An organizational backup from within the last seven days is available"
},
{
"severity": "Recommended",
"groupName": "Backup",
"name": "backup_schedule_exist",
"description": "Backups are scheduled to run at regular intervals"
},
{
"severity": "Critical",
"groupName": "Backup",
"name": "scheduled_backup_store_healthy",
"description": "All backup stores associated with backup schedules are valid"
},
{
"severity": "Critical",
"groupName": "Security",
"name": "identity_certificate_validity_7days_or_more",
"description": "Identity certificates are valid for 7 or more days."
},
{
"severity": "Important",
"groupName": "Security",
"name": "identity_certificate_validity_14days_or_more",
"description": "Identity certificates are valid for 14 or more days."
},
{
"severity": "Recommended",
"groupName": "Security",
"name": "identity_certificate_validity_30days_or_more",
"description": "Identity certificates are valid for 30 or more days. "
},
{
"severity": "Critical",
"groupName": "License",
"name": "license_validity_7days_or_more",
"description": "The ArcGIS Enterprise license is valid for 7 or more days"
},
{
"severity": "Important",
"groupName": "License",
"name": "license_validity_14days_or_more",
"description": "The ArcGIS Enterprise license is valid for 14 or more days"
},
{
"severity": "Recommended",
"groupName": "License",
"name": "license_validity_30days_or_more",
"description": "The ArcGIS Enterprise license is valid for 30 or more days"
},
{
"severity": "Important",
"groupName": "Data Store",
"name": "relational_store_threshold",
"description": "Relational store has sufficient available storage"
},
{
"severity": "Important",
"groupName": "Data Store",
"name": "spatiotemporal_store_threshold",
"description": "Spatiotemporal and index store has sufficient available storage"
},
{
"severity": "Important",
"groupName": "Data Store",
"name": "object_store_threshold",
"description": "Object store has sufficient available storage"
},
{
"severity": "Critical",
"groupName": "Data Store",
"name": "relational_store_replication_status",
"description": "Relational store replication between Primary and Standby pod is current"
},
{
"severity": "Critical",
"groupName": "Other",
"name": "validate_federated_server",
"description": "Federated servers have been validated"
},
{
"severity": "Important",
"groupName": "Other",
"name": "log_level_test ",
"description": "Log level is appropriate for general use"
}
],
"generalTests": [],
"name": "Operational health check",
"description": "Provides insights into operational efficiency and the early detection of tential issues across multiple areas of Enterprise.",
"criticalTests": [],
"id": "OHC-001"
}
]
}