Skip to content

IX-API API

by ix-api.net

Bearer tokenHTTPSSecurity
Open documentation ↗

Overview

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.

IX-API is a security API from ix-api.net. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 78 endpoints.

At a glance

Authentication
Bearer token
HTTPS
Yes
CORS
Unknown
Category
Security
Version
2.1.0
Endpoints
78
Spec updated
2021-08-16

Endpoints

MethodPathWhat it does
GET/accountsRetrieve a list of `Account`s.
POST/accountsCreate a new account.
GET/accounts/{id}Get a single account.
PUT/accounts/{id}Update the entire account.
PATCH/accounts/{id}Update parts of an account.
DELETE/accounts/{id}Accounts can be deleted, when all services and configs
POST/auth/refreshReauthenticate the API user, issue a new `access_token`
POST/auth/tokenAuthenticate an API user identified by `api_key` and
GET/connectionsList all `connection`s.
GET/connections/{id}Read a `connection`.
GET/contactsList available contacts managed by the authorized account.
POST/contactsCreate a new contact.
GET/contacts/{id}Get a contact by it's id
PUT/contacts/{id}Update a contact
PATCH/contacts/{id}Update parts of a contact
DELETE/contacts/{id}Remove a contact.
GET/devicesList available devices
GET/devices/{id}Get a specific device identified by id
GET/facilitiesGet a (filtered) list of `facilities`.
GET/facilities/{id}Retrieve a facility by id
GET/healthGet the IX-API service health status.
GET/implementationGet the API implementation details.
GET/ipsList all ip addresses (and prefixes).
POST/ipsAdd an ip host address or network prefix.
GET/ips/{id}Get a single ip addresses by it's id.
PUT/ips/{id}Update an ip address object.
PATCH/ips/{id}Update parts of an ip address.
GET/macsList all mac addresses managed by the authorized customer.
POST/macsRegister a mac address.
GET/macs/{id}Get a single mac address by it's id.
DELETE/macs/{id}Remove a mac address.
GET/member-joining-rulesGet a list of joining rules
POST/member-joining-rulesCreate a member joining rule
GET/member-joining-rules/{id}Get a single rule
PUT/member-joining-rules/{id}Update a joining rule
PATCH/member-joining-rules/{id}Partially update a joining rule
DELETE/member-joining-rules/{id}Delete a joining rule
GET/metro-area-networksList all MetroAreaNetworks
GET/metro-area-networks/{id}Retrieve a MetroAreaNetwork
GET/metro-areasList all MetroAreas
GET/metro-areas/{id}Get a single MetroArea
GET/network-feature-configsGet all network feature configs.
POST/network-feature-configsCreate a configuration for a `NetworkFeature`
GET/network-feature-configs/{id}Get a single network feature config.
PUT/network-feature-configs/{id}Update a network feature configuration
PATCH/network-feature-configs/{id}Update parts of a network feature configuration
DELETE/network-feature-configs/{id}Remove a network feature config.
GET/network-featuresList available network features.
GET/network-features/{id}Get a single network feature by it's id.
GET/network-service-configsGet all `network-service-config`s.
POST/network-service-configsCreate a `network-service-config`.
GET/network-service-configs/{id}Get a `network-service-config`
PUT/network-service-configs/{id}Update an exisiting `network-service-config`
PATCH/network-service-configs/{id}Update parts of an exisiting `network-service-config`.
DELETE/network-service-configs/{id}Request decommissioning the network service configuration.
GET/network-service-configs/{id}/cancellation-policyThe cancellation-policy can be queried to answer
GET/network-servicesList available `NetworkService`s.
POST/network-servicesCreate a new network service
GET/network-services/{id}Get a specific `network-service` by id.
PUT/network-services/{id}Update a network service
PATCH/network-services/{id}Partially update a network service
DELETE/network-services/{id}Request decomissioning of the network service.
GET/network-services/{id}/cancellation-policyThe cancellation-policy can be queried to answer
GET/network-services/{id}/change-requestGet the change request.
POST/network-services/{id}/change-requestRequest a change to the network service.
DELETE/network-services/{id}/change-requestRetract or reject a change to the network service.
GET/popsList all PoPs
GET/pops/{id}Get a single point of presence
GET/portsList all ports.
GET/ports/{id}Retrieve a port.
GET/product-offeringsList all (filtered) products-offerings available on the platform
GET/product-offerings/{id}Get a single products-offering by id.
GET/role-assignmentsList all role assignments for a contact.
POST/role-assignmentsAssign a `Role` to a `Contact`.
GET/role-assignments/{assignment_id}Get a role assignment for a contact.
DELETE/role-assignments/{assignment_id}Remove a role assignment from a contact.
GET/rolesList all roles available.
GET/roles/{id}Get a single `Role`.

Questions

Does the IX-API API need an API key?

Yes. The IX-API API uses Bearer token authentication; the documentation explains how to get credentials.

Does the IX-API API support HTTPS?

Yes, the IX-API API is served over HTTPS.

How many endpoints does the IX-API API have?

Its OpenAPI description lists 78 endpoints in version 2.1.0. All of them are shown on this page.

What are alternatives to the IX-API API?

Other Security APIs include Microsoft Security Response Center (MSRC), National Vulnerability Database, Cisco PSIRT openVuln API, Shodan, BitWarden.

Compare alternatives →

Microsoft Security Response Center (MSRC)

Security

Programmatic interfaces to engage with the Microsoft Security Response Center (MSRC)

No auth

National Vulnerability Database

Security

U.S. National Vulnerability Database

No auth

Cisco PSIRT openVuln API

Security

The Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information). For more information about the Cisco PSIRT openVuln API visit https://developer.cisco.com/site/PSIRT/discover/overview For detail steps on how to use the API go to:https://developer.cisco.com/site/PSIRT/get-started/getting-started.gsp This is a beta release of a swagger YAML for the Cisco PSIRT openVuln API To access the API sign in with your Cisco CCO account at http://apiconsole.cisco.com and register an application to recieve a client_id and a client_secret You can then get your token using curl or any other method you prefer. 'curl -s -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "client_id=<your_client_id>" -d "client_secret=<your_client_secret>" -d "grant_type=client_credentials" https://cloudsso.cisco.com/as/token.oauth2' You will receive an access token as demonstrated in the following example: '{"access_token":"I7omWtBDAieSiUX3shOxNJfuy4J6","token_type":"Bearer","expires_in":3599}' In Swagger, click on Change Authentication enter the text "I7omWtBDAieSiUX3shOxNJfuy4J6" (which is the token you received) then click on "Try this operation"

OAuth19 endpoints

Shodan

Security

Search engine for Internet connected devices

API key

BitWarden

Security

Best open-source password manager

OAuth

HaveIBeenPwned

Security

Passwords which have previously been exposed in data breaches

API key

Listed from APIs.guru (CC0).