Skip to main content
Resources

Monitoring System API Specification

Overview

Monitoring System API (MoSAPI) is a REST API that allows registry operators to retrieve information collected by the SLA Monitoring (SLAM) system. The Service Level Agreement Monitoring (SLAM) system is a tool managed by ICANN to measure in near real-time the Service Level Agreements (SLA) defined in Specification 10 of the Base gTLD Registry Agreement.

The MoSAPI includes the ability to:

  • Monitor the state of a TLD.
  • Monitor the alarm status of a service.
  • Monitor the availability of a service.
  • Monitor the state of a particular incident.
  • Monitor the false positive flag of an incident.
  • Query a list of incidents for a service.
  • Query the list of measurements for an incident.
  • Query the details of a particular measurement.
  • Retrieve the list of IP addresses used in the probe node network.
  • Manage maintenance windows:
    • Create or update a maintenance window schedule to suspend SLA Monitoring System 10 percent emergency threshold alerts for Registration Data Directory Service (RDDS) and Extensible Provisioning Protocol (EPP) 10 percent emergency threshold alerts for a predefined period.
    • Delete a maintenance window schedule.
    • Retrieve a maintenance window schedule.
    • Obtain a list of maintenance windows that have not yet ended.

The MoSAPI also provides information on alerts and the health of the services to registry operators that can be used for troubleshooting purposes.

The MoSAPI is available to both gTLDs and ccTLDs.

Results for ccTLDs are logged in SLAM according to the same thresholds and ccTLD operators may opt in to MoSAPI, however no alerts or actions are triggered when a failure is detected on those services.

Get access to the MoSAPI

gTLDs

You can access the MoSAPI from the IP addresses that you have whitelisted for accessing the Registry Reporting Interface (RRI) with your RRI credentials. The RRI credentials and the IP addresses whitelisted for accessing the RRI are managed through the Naming Services portal. If you have not already done so, you will need to provide both the IPv6 and IPv4 prefixes that you will use to connect to the MoSAPI for whitelisting, via the TLDs tab on the Naming Services portal.

More information about the Naming Services portal may be found in the "Naming Services portal" section in the Registry Resources page.

 ccTLDs

To request access to the MoSAPI, please contact the ICANN Global Support Center identifying the ccTLD for which you are requesting access. ICANN will contact the administrative and technical contacts of the ccTLD as listed in the IANA Root Database to validate the information and provide access.

Specification

Current version:

Previous versions:

Domain Name System
Internationalized Domain Name ,IDN,"IDNs are domain names that include characters used in the local representation of languages that are not written with the twenty-six letters of the basic Latin alphabet ""a-z"". An IDN can contain Latin letters with diacritical marks, as required by many European languages, or may consist of characters from non-Latin scripts such as Arabic or Chinese. Many languages also use other types of digits than the European ""0-9"". The basic Latin alphabet together with the European-Arabic digits are, for the purpose of domain names, termed ""ASCII characters"" (ASCII = American Standard Code for Information Interchange). These are also included in the broader range of ""Unicode characters"" that provides the basis for IDNs. The ""hostname rule"" requires that all domain names of the type under consideration here are stored in the DNS using only the ASCII characters listed above, with the one further addition of the hyphen ""-"". The Unicode form of an IDN therefore requires special encoding before it is entered into the DNS. The following terminology is used when distinguishing between these forms: A domain name consists of a series of ""labels"" (separated by ""dots""). The ASCII form of an IDN label is termed an ""A-label"". All operations defined in the DNS protocol use A-labels exclusively. The Unicode form, which a user expects to be displayed, is termed a ""U-label"". The difference may be illustrated with the Hindi word for ""test"" — परीका — appearing here as a U-label would (in the Devanagari script). A special form of ""ASCII compatible encoding"" (abbreviated ACE) is applied to this to produce the corresponding A-label: xn--11b5bs1di. A domain name that only includes ASCII letters, digits, and hyphens is termed an ""LDH label"". Although the definitions of A-labels and LDH-labels overlap, a name consisting exclusively of LDH labels, such as""icann.org"" is not an IDN."