{"@context": "https://schema.org", "@type": "WebAPI", "name": "IX-API API", "description": "This API allows to config/change/delete Internet Exchange services. # Filters When querying collections, the provided query parameters are validated. Unknown query parameters are ignored. Providing invalid filter values should yield a validation error.", "provider": {"@type": "Organization", "name": "ix-api.net"}, "documentation": "https://docs.ix-api.net/v2/ix-api-latest.json"}
Index / APIs / ix-api.net

IX-API API

This API allows to config/change/delete Internet Exchange services. # Filters When querying collections, the provided query parameters are validated. Unknown query parameters are ignored. Providing invalid filter values should yield a validation error.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

auth: b e a r

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

IX-API v2.1.0

This API allows to config/change/delete Internet Exchange services. # Filters When querying collections, the provided query parameters are validated. Unknown query parameters are ignored. Providing invalid filter values should yield a validation error.

methodpathwhat the vendor says it does
GET/accountsRetrieve a list of `Account`s. This includes all accounts the currently authorized account is managing and th
POST/accountsCreate a new account. accounts
GET/accounts/{id}Get a single account. accounts
PUT/accounts/{id}Update the entire account. accounts
PATCH/accounts/{id}Update parts of an account. accounts
DELETE/accounts/{id}Accounts can be deleted, when all services and configs are decommissioned or the account is not longer referen
POST/auth/refreshReauthenticate the API user, issue a new `access_token` and `refresh_token` pair by providing the `refresh_tok
POST/auth/tokenAuthenticate an API user identified by `api_key` and `api_secret`. auth
GET/connectionsList all `connection`s. connections
GET/connections/{id}Read a `connection`. connections
GET/contactsList available contacts managed by the authorized account. contacts
POST/contactsCreate a new contact. contacts
GET/contacts/{id}Get a contact by it's id contacts
PUT/contacts/{id}Update a contact contacts
PATCH/contacts/{id}Update parts of a contact contacts
DELETE/contacts/{id}Remove a contact. Please note, that a contact can only be removed if it is not longer in use in a network ser
GET/devicesList available devices devices
GET/devices/{id}Get a specific device identified by id devices
GET/facilitiesGet a (filtered) list of `facilities`. facilities
GET/facilities/{id}Retrieve a facility by id facilities
GET/healthGet the IX-API service health status. health
GET/implementationGet the API implementation details. implementation
GET/ipsList all ip addresses (and prefixes). ips
POST/ipsAdd an ip host address or network prefix. ips
GET/ips/{id}Get a single ip addresses by it's id. ips
PUT/ips/{id}Update an ip address object. You can only update IP addresses within your current scope. Not all addresses yo
PATCH/ips/{id}Update parts of an ip address. As with the `PUT` opertaion, IP addresses, where you don't have update rights
GET/macsList all mac addresses managed by the authorized customer. macs
POST/macsRegister a mac address. macs
GET/macs/{id}Get a single mac address by it's id. macs
DELETE/macs/{id}Remove a mac address. macs
GET/member-joining-rulesGet a list of joining rules member-joining-rules
POST/member-joining-rulesCreate a member joining rule member-joining-rules
GET/member-joining-rules/{id}Get a single rule member-joining-rules
PUT/member-joining-rules/{id}Update a joining rule member-joining-rules
PATCH/member-joining-rules/{id}Partially update a joining rule member-joining-rules
DELETE/member-joining-rules/{id}Delete a joining rule member-joining-rules
GET/metro-area-networksList all MetroAreaNetworks metro-area-networks
GET/metro-area-networks/{id}Retrieve a MetroAreaNetwork metro-area-networks
GET/metro-areasList all MetroAreas metro-areas

and 38 more operation(s) in this specification, all searchable.

specification origin: https://docs.ix-api.net/v2/ix-api-latest.json

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.