Tools (80)

Extracted live via the executor SDK.

• accounts.accountsCreate

  Create a new account.

• accounts.accountsDestroy

  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.

• accounts.accountsList

  Retrieve a list of Accounts.

  This includes all accounts the currently authorized account is managing and the current account itself.

• accounts.accountsPartialUpdate

  Update parts of an account.

• accounts.accountsRead

  Get a single account.

• accounts.accountsUpdate

  Update the entire account.

• auth.authTokenCreate

  Authenticate an API user identified by api_key and api_secret.

• auth.authTokenRefresh

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

• connections.connectionsList

  List all connections.

• connections.connectionsRead

  Read a connection.

• contacts.contactsCreate

  Create a new contact.

• contacts.contactsDestroy

  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.

• contacts.contactsList

  List available contacts managed by the authorized account.

• contacts.contactsPartialUpdate

  Update parts of a contact

• contacts.contactsRead

  Get a contact by it's id

• contacts.contactsUpdate

  Update a contact

• devices.devicesList

  List available devices

• devices.devicesRead

  Get a specific device identified by id

• facilities.facilitiesList

  Get a (filtered) list of facilities.

• facilities.facilitiesRead

  Retrieve a facility by id

• health.apiHealthRead

  Get the IX-API service health status.

• implementation.apiImplementationRead

  Get the API implementation details.

• ips.ipsCreate

  Add an ip host address or network prefix.

• ips.ipsList

  List all ip addresses (and prefixes).

• ips.ipsPartialUpdate

  Update parts of an ip address.

  As with the PUT opertaion, IP addresses, where you don't have update rights, will yield a resource access denied error when attempting an update.

  If the ip address was allocated for you, you might not be able to change anything but the fqdn.

• ips.ipsRead

  Get a single ip addresses by it's id.

• ips.ipsUpdate

  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.

• macs.macsCreate

  Register a mac address.

• macs.macsDestroy

  Remove a mac address.

• macs.macsList

  List all mac addresses managed by the authorized customer.

• macs.macsRead

  Get a single mac address by it's id.

• memberJoiningRules.memberJoiningRulesCreate

  Create a member joining rule

• memberJoiningRules.memberJoiningRulesDestroy

  Delete a joining rule

• memberJoiningRules.memberJoiningRulesList

  Get a list of joining rules

• memberJoiningRules.memberJoiningRulesPartialUpdate

  Partially update a joining rule

• memberJoiningRules.memberJoiningRulesRead

  Get a single rule

• memberJoiningRules.memberJoiningRulesUpdate

  Update a joining rule

• metroAreaNetworks.metroAreaNetworksList

  List all MetroAreaNetworks

• metroAreaNetworks.metroAreaNetworksRead

  Retrieve a MetroAreaNetwork

• metroAreas.metroAreasList

  List all MetroAreas

• metroAreas.metroAreasRead

  Get a single MetroArea

• networkFeatureConfigs.networkFeatureConfigsCreate

  Create a configuration for a NetworkFeature defined in the NetworkFeatures collection.

• networkFeatureConfigs.networkFeatureConfigsDestroy

  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.

• networkFeatureConfigs.networkFeatureConfigsList

  Get all network feature configs.

• networkFeatureConfigs.networkFeatureConfigsPartialUpdate

  Update parts of a network feature configuration

• networkFeatureConfigs.networkFeatureConfigsRead

  Get a single network feature config.

• networkFeatureConfigs.networkFeatureConfigsUpdate

  Update a network feature configuration

• networkFeatures.networkFeaturesList

  List available network features.

• networkFeatures.networkFeaturesRead

  Get a single network feature by it's id.

• networkServiceConfigs.networkServiceConfigCancellationPolicyRead

  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).

• networkServiceConfigs.networkServiceConfigsCreate

  Create a network-service-config.

• networkServiceConfigs.networkServiceConfigsDestroy

  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.

• networkServiceConfigs.networkServiceConfigsList

  Get all network-service-configs.

• networkServiceConfigs.networkServiceConfigsPartialUpdate

  Update parts of an exisiting network-service-config.

• networkServiceConfigs.networkServiceConfigsRead

  Get a network-service-config

• networkServiceConfigs.networkServiceConfigsUpdate

  Update an exisiting network-service-config

• networkServices.networkServiceCancellationPolicyRead

  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).

• networkServices.networkServiceChangeRequestCreate

  Request a change to the network service.

  A participant in a network service of type p2p_vc can issue a change request, expressing a desired change in the capacity. The change is accepted when all sides have configured the network service configs with the new bandwidth. These changes can sometimes require a change of the product offering. The product offering may only differ in regards to bandwidth.

  The network service will change it's state from production into production_change_pending.

  Only one change request may be issued at a time.

• networkServices.networkServiceChangeRequestDestroy

  Retract or reject a change to the network service.

• networkServices.networkServiceChangeRequestRead

  Get the change request.

• networkServices.networkServicesCreate

  Create a new network service

• networkServices.networkServicesDestroy

  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.

• networkServices.networkServicesList

  List available NetworkServices.

• networkServices.networkServicesPartialUpdate

  Partially update a network service

• networkServices.networkServicesRead

  Get a specific network-service by id.

• networkServices.networkServicesUpdate

  Update a network service

• pops.popsList

  List all PoPs

• pops.popsRead

  Get a single point of presence

• ports.portsList

  List all ports.

• ports.portsRead

  Retrieve a port.

• productOfferings.productOfferingsList

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

• productOfferings.productOfferingsRead

  Get a single products-offering by id.

• roleAssignments.roleAssignmentsCreate

  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.

• roleAssignments.roleAssignmentsDestroy

  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.

• roleAssignments.roleAssignmentsList

  List all role assignments for a contact.

• roleAssignments.roleAssignmentsRead

  Get a role assignment for a contact.

• roles.rolesList

  List all roles available.

• roles.rolesRead

  Get a single Role.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools