Skip to content

Schema Field Entries

Nick Hilliard edited this page Dec 18, 2015 · 11 revisions

Schema Field Entries - IXP Structure

version - this is the numeric version of the schema definition from the github tag. This should be set to one of the following values:

  • 0.3
  • 0.4
  • 0.5

timestamp - this is the timestamp that the data was exported from the IXP. This must be specified in ISO8601 combined date+time format using the UTC time zone. E.g. 2015-07-16T10:08:09Z which refers to July 16, 2015 at 8 minutes past 10 in the morning. The year must be specified in YYYY format. Implementers must not use US-style MM-DD-(YY)YY or European style DD-MM-(YY)YY format. The time should be specified in 24h format, and not contain am/pm signifiers.

ixp_list - an array of IXP infrastructures which are operated by the IXP.

ixp_list.[].ixp_id - a numeric IXP identifier. Where possible, this index number should be consistent across exports. However as the index is primarily intended to be used as an internal index within the schema, it is not required to be consistent across exports.

ixp_list.[].shortname - this is the short operating name of the IXP, in contrast to the full legal name of the entity. For example, INEX rather than Internet Neutral Exchange Association Limited.

ixp_list.[].name - this is the full legal name of the IXP. For example, Internet Neutral Exchange Association Limited rather than INEX.

ixp_list.[].url - the full IXP web site URL. This URL should contain the protocol, e.g. http://www.inex.ie/ or https://www.inex.ie/, not just www.inex.ie.

ixp_list.[].stats_api - the URL of the Euro-IX statistics export schema as presented by the IXP. This schema has not yet been defined, so as of version 0.5 of the member list schema, this entry should be omitted from the output or else left blank.

ixp_list.[].country - the 2-character ISO3166 country code where the IXP is legally registered.

ixp_list.[].ixf_id - the numeric index of the IXP in the IX Federation database. This is defined as the id of the IXP in the online IX-F database which can be found at the following endpoint: http://db.ix-f.net/api/ixp. Note that this is a persistent index keyed on an external database source.

ixp_list.[].support_email - the technical support email address of the IXP. This is a free-form data field and it should be populated with a single rfc822-formatted email address.

ixp_list.[].support_phone - the technical support telephone number of the IXP, where it exists. This should be formatted using standard international telephone syntax, suitable for direct dialling from a hyperlink. E.g. +1 702 555 1234.

ixp_list.[].support_contact_hours - a free-form field showing the normal manned support contact hours of the IXP. E.g. 24x7, or 8x5 GMT, excluding public holidays.

ixp_list.[].emergency_email - the emergency technical support contact email, if different from the normal technical support contact email address. This would normally be used for out-of-hours email support requests.

ixp_list.[].emergency_phone - the emergency technical support contact phone number, if different from the normal technical support phone number. This would normally be used for out-of-hours telephone support requests. This field should be formatted using standard international telephone syntax.

ixp_list.[].emergency_contact_hours - a free-form field showing the contact hours of the IXP when the emergency fields are appropriate to use.

ixp_list.[].billing_email - the billing contact email of the IXP in rfc822 format.

ixp_list.[].billing_phone - the billing contact phone numer of the IXP in standard international phone number format.

ixp_list.[].billing_contact_hours - the times when the billing department of the IXP is manned.

ixp_list.[].peering_policy_list - a JSON array of peering policies available from IXP participants. Most IXP participants use a limited number of peering policy types. It is suggested that this field contain something similar to the following values:

  • open - will peer on request unless there are specific mitigating circumstances.
  • selective - may peer.
  • case-by-case - each case is considered individually.