IX-API

Get the currently authenticated Account. Mocked via Mockzilla.

Retrieve a list of Accounts. This includes all accounts the currently authorized account is managing and the current account itself. Also discoverable accounts will be included, however sensitive properties, like address or external_ref will either not be present or redacted.

Create a new account.

Accounts can be deleted, when all services and configs are decommissioned or the account is not longer referenced e.g. as a managing_account or billing_account. Deleting an account will cascade to contacts and role-assignments. The request will immediately fail, if the above preconditions are not met.

Get a single account.

Update an account. Available as a Mockzilla mock endpoint.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update the entire account.

Reauthenticate the API user, issue a new access_token and refresh_token pair by providing the refresh_token in the request body.

Authenticate an API user identified by api_key and api_secret.

List all availability zones available on the platform.

Get a single availability zone by id. Mockzilla mock: no signup, no API key.

List all connections.

Create a new connection and request ports allocation. Two workflows for allocating ports is supported and dependent on the cross_connect_initiator property of the corresponding product-offering: When the initiator is the subscriber, a Letter Of Authorization (LOA) can be downloaded from the /connection//loa resource. In case the exchange is the initiator, the LOA can be uploaded to this resource. Creating a connection will also create PortReservations. See the port_quantity and subscriber_side_demarcs attributes for details. Please refer to the internet exchange's api usage guide for implementation specific details.

Request decommissioning the connection. The cancellation policy of the connection applies here and is independent from the policy of the network-service and network-service-config using the connection. The connection will assume the state decommission_requested. Associated port-reservation will be also marked for decommissining and ports will be deallocated. The decommissioning request will not cascade to network services and configs.

Read a connection.

Update a connection. Served by the Mockzilla mock runtime.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a connection.

The cancellation-policy can be queried to answer the questions: If I cancel my subscription, when will it be technically decommissioned? If I cancel my subscription, until what date will I be charged? When the query parameter decommision_at is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).

Download the Letter Of Authorization associated with the connection. In case of a subscriber initiated cross-connect, it will be provided by the exchange.

Upload a Letter Of Authorization for this connection. The LOA is valid for the entire connection and must include all ports.

Read a Connections aggregated statistics. A start and end query parameter can be used to retrieve the aggregated traffic for a given window. In this case the key of the returned statistics is custom. With a given start and end window, the resolution for the aggregated data is chosen by the implementation. You need to check the accuracy attribute of the aggregate, to see if the data can be used for the desired usecase. The accuracy is the ratio of total samples to expected samples. If no start or end parameter is given, a sliding window is assumed and key value pairs of resolutions and aggregated statistics are returned. Mocked via Mockzilla.

Read a Connections aggregated timeseries. The resolution is defined by the aggregate.

List available contacts managed by the authorized account.

Create a new contact.

Remove a contact. Please note, that a contact can only be removed if it is not longer in use in a network service or config through a role assignment.

Get a contact by it's id. Available as a Mockzilla mock endpoint.

Update a contact.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a contact.

List available devices

Get a specific device identified by id

List provider extensions to the IX-API. Mockzilla mock: no signup, no API key.

Get a (filtered) list of facilities.

Retrieve a facility by id

Get the IX-API service health status.

Get the API implementation details.

List all ip addresses (and prefixes). Served by the Mockzilla mock runtime.

Add an ip host address or network prefix.

Get a single ip addresses by it's id.

Update an ip address. You can only update IP addresses within your current scope. Not all addresses you can read you can update. If the ip address was allocated for you, you might not be able to change anything but the fqdn.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update an ip address object. You can only update IP addresses within your current scope. Not all addresses you can read you can update. If the ip address was allocated for you, you might not be able to change anything but the fqdn.

List all mac addresses managed by the authorized customer. Mocked via Mockzilla.

Register a mac address.

Remove a mac address.

Get a single mac address by it's id.

Get a list of joining rules

Create a member joining rule. Available as a Mockzilla mock endpoint.

Delete a joining rule

Get a single rule

Update a joining rule

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a joining rule.

List all MetroAreaNetworks. Mockzilla mock: no signup, no API key.

Retrieve a MetroAreaNetwork

List all MetroAreas

Get a single MetroArea

Get all network feature configs.

Create a configuration for a NetworkFeature defined in the NetworkFeatures collection. Served by the Mockzilla mock runtime.

Remove a network feature config. The network feature config will be marked as decommission_requested. Decommissioning a network feature config will not cascade to related services or service configs.

Get a single network feature config.

Update a network feature configuration.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a network feature configuration

List available network features. Mocked via Mockzilla.

Get a single network feature by it's id.

Get all network-service-configs.

Create a network-service-config.

Request decommissioning the network service configuration. The network service config will assume the state decommission_requested. This will cascade to related resources like network-feature-configs.

Get a network-service-config. Available as a Mockzilla mock endpoint.

Update an exisiting network-service-config.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update an exisiting network-service-config

The cancellation-policy can be queried to answer the questions: If I cancel my subscription, when will it be technically decommissioned? If I cancel my subscription, until what date will I be charged? When the query parameter decommision_at is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).

Read the aggregated statistics of a NetworkServiceConfig. A start and end query parameter can be used to retrieve the aggregated traffic for a given window. In this case the key of the returned statistics is custom. With a given start and end window, the resolution for the aggregated data is chosen by the implementation. You need to check the accuracy attribute of the aggregate, to see if the data can be used for the desired usecase. The accuracy is the ratio of total samples to expected samples. If no start or end parameter is given, a sliding window is assumed and key value pairs of resolutions and aggregated statistics are returned.

Read a NetworkServiceConfigs aggregated timeseries. The resolution is defined by the aggregate. Mockzilla mock: no signup, no API key.

List available NetworkServices.

Create a new network service

Request decomissioning of the network service. The network service will enter the state of decommission_requested. The request will cascade to related network service and feature configs. An optional request body can be provided to request a specific service termination date. If no date is given in the request body, it is assumed to be the earliest possible date. Possible values for decommission_at can be queried through the network_service_cancellation_policy_read operation. The response will contain the dates on which the changes will be effected.

Get a specific network-service by id.

Update a network service. Served by the Mockzilla mock runtime.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a network service.

The cancellation-policy can be queried to answer the questions: If I cancel my service, when will it be technically decommissioned? If I cancel my service, until what date will I be charged? When the query parameter decommision_at is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).

Retract or reject a change to the network service.

Get the change request.

Request a change to the network service. The B-side participant in a peer-to-peer network service (p2p_vc) can issue a change request, expressing a desired change in the capacity. The change is accepted when the A-side has configured the network service and config with the new bandwidth. This is done using the network_service_update, network_service_partial_update, network_service_config_update or network_service_config_partial_update operations by the A-side. These changes can sometimes require a change of the product offering. The product offering may only differ in bandwidth. The network service will change its state from production into production_change_pending. A change can by rejected (by the A-side) or retracted (by the B-side) using the network_service_change_request_destroy operation. Only one change request may be issued at a time. A change request by the A-side is not a valid request and will be rejected. Mocked via Mockzilla.

Read a NetworkServices aggregated statistics. A start and end query parameter can be used to retrieve the aggregated traffic for a given window. In this case the key of the returned statistics is custom. With a given start and end window, the resolution for the aggregated data is chosen by the implementation. You need to check the accuracy attribute of the aggregate, to see if the data can be used for the desired usecase. The accuracy is the ratio of total samples to expected samples. If no start or end parameter is given, a sliding window is assumed and key value pairs of resolutions and aggregated statistics are returned.

Read a NetworkServices aggregated timeseries. The resolution is defined by the aggregate.

List all PoPs

Get a single point of presence

List all port reservations. Available as a Mockzilla mock endpoint.

Create a new PortReservation. Two workflows for allocating ports is supported and dependent on the cross_connect_initiator property of the corresponding product-offering: Individual LOAs can be uploaded and downloaded for each PortAllocation using the endpoint /port-reservations/{id}/loa. Please refer to the internet exchange's api usage guide for implementation specific details.

Request decommissioning the port-reservation. The associated port will be deallocated and removed from the connection.

Retrieve a PortReservation.

Update a port reservation.

DEPRECATION NOTICE: This operation will be removed in favor of using PATCH for all updates. Update a port reservation. Mockzilla mock: no signup, no API key.

The cancellation-policy can be queried to answer the questions: If I cancel my subscription, when will it be technically decommissioned? If I cancel my subscription, until what date will I be charged? When the query parameter decommision_at is not provided it will provide the first possible cancellation date and charge period if cancelled at above date. The granularity of the date field is a day, the start and end of which are to be interpreted by the IXP (some may use UTC, some may use their local time zone).

Download the Letter Of Authorization associated with the port-reservation. In case of a subscriber initiated cross-connect, it will be provided by the exchange.

Upload a Letter Of Authorization for this PortReservation.

List all ports.

Retrieve a port. Served by the Mockzilla mock runtime.

Read a Ports aggregated statistics. A start and end query parameter can be used to retrieve the aggregated traffic for a given window. In this case the key of the returned statistics is custom. With a given start and end window, the resolution for the aggregated data is chosen by the implementation. You need to check the accuracy attribute of the aggregate, to see if the data can be used for the desired usecase. The accuracy is the ratio of total samples to expected samples. If no start or end parameter is given, a sliding window is assumed and key value pairs of resolutions and aggregated statistics are returned.

Read a Ports aggregated timeseries. The resolution is defined by the aggregate.

List all (filtered) products-offerings available on the platform

Get a single products-offering by id.

List all role assignments for a contact. Mocked via Mockzilla.

Assign a Role to a Contact. The contact needs to have all fields filled, which the role requires. If this is not the case a 400 UnableToFulfill will be returned.

Remove a role assignment from a contact. If the contact is still in use with a given role required, this will yield an UnableToFulfill error.

Get a role assignment for a contact.

List all roles available.

Get a single Role. Available as a Mockzilla mock endpoint.