The XSEDE Information Services warehouse contains information about infrastructure, projects, and people. The information is aggregated from various information sources, cross-referenced, and made available thru web APIs. These web APIs are grouped by target user audience and by the type of information they contain:
- Discovery APIs: the most useful APIs for developers/users which integrating information from all available sources
- Specific Source APIs: provide access to information from a single source
- Client Tool APIs: provide access to the combination of information needed by specific client tools
Each of these API groups are described in more detail below. All these APIs return information in JSON format. Some also return information in XML, CSV, and HTML formats. The following (Swagger) self documentation describes each API's URLs and arguments:
A detailed Design/Security Review description is here.
These are the best APIs for the general user community and provide all the available information from all available sources.
|glue2-views-api||Information about network accessible services, command line HPC/HTC resource software, and batch jobs published using the GLUE2 information model. Batch job information requires XSEDE OAuth authentication.|
|monitoring-views-api||All available monitoring information.|
|outages||All available resource outage information.|
|projectresources||Views showing which resources each allocation has access to.|
|resource-api||Cross institutional research information technology discovery (training, consulting, software, services, curated guides, etc.)|
|resource-status-api||Comprehensive views of resource status information, including the declared operational status in RDR, outage status, monitoring/testing status, batch system status and utilization, and dynamic resource information publishing status.|
|warehouse-views||Comprehensive resource and software views, including pages viewable with a browser (HTML).|
Views of information from the Research Software Portal:
Specific Source APIs
These APIs access or maintain information from a specific source.
|glue2-db-api||SP resource batch system, compute nodes, accelerator nodes, network services, applications/software, and batch jobs published in OGF standard GLUE2 format using the IPF publishing tool.|
For posting new GLUE2 information into the warehouse.
|monitoring-db-api||INCA and Nagios monitoring/testing results.|
|monitoring-provider-api||For posting new Monitoring information into the warehouse.|
|processing-status||Internal information services processing status and recent processing errors.|
Information from the XSEDE Central Database "XCDB":
Client Tool APIs
These APIs access the information needed by specific tools.
|goendpoint-api||XSEDE's Globus Transfer Endpoints based on the GridFTP servers that SPs have advertised using IPF.|
|xdinfo||API used by the xdinfo command line tool.|