Ix API

IX-API

API version: 2.7.1

Auth

Bearer bearer | OAuth2

Base URL

/api/v2

Setup

1. Set Authorization header with your Bearer token
2. GET /facilities -- verify access
3. POST /auth/token -- create first token

Endpoints

115 endpoints across 27 groups. See references/api-spec.lap for full details.

auth

facilities

devices

pops

metro-area-networks

metro-areas

product-offerings

availability-zones

ports

port-reservations

connections

network-service-configs

network-feature-configs

account

accounts

roles

contacts

role-assignments

health

implementation

extensions

ips

macs

network-services

network-features

member-joining-rules

routing-functions

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a token?" -> POST /auth/token
• "Create a refresh?" -> POST /auth/refresh
• "List all facilities?" -> GET /facilities
• "Get facility details?" -> GET /facilities/{id}
• "List all devices?" -> GET /devices
• "Get device details?" -> GET /devices/{id}
• "List all pops?" -> GET /pops
• "Get pop details?" -> GET /pops/{id}
• "List all metro-area-networks?" -> GET /metro-area-networks
• "Get metro-area-network details?" -> GET /metro-area-networks/{id}
• "List all metro-areas?" -> GET /metro-areas
• "Get metro-area details?" -> GET /metro-areas/{id}
• "List all product-offerings?" -> GET /product-offerings
• "Get product-offering details?" -> GET /product-offerings/{id}
• "List all availability-zones?" -> GET /availability-zones
• "Get availability-zone details?" -> GET /availability-zones/{id}
• "List all ports?" -> GET /ports
• "Get port details?" -> GET /ports/{id}
• "List all statistics?" -> GET /ports/{id}/statistics
• "List all timeseries?" -> GET /ports/{id}/statistics/{aggregate}/timeseries
• "List all port-reservations?" -> GET /port-reservations
• "Create a port-reservation?" -> POST /port-reservations
• "Get port-reservation details?" -> GET /port-reservations/{id}
• "Update a port-reservation?" -> PUT /port-reservations/{id}
• "Partially update a port-reservation?" -> PATCH /port-reservations/{id}
• "Delete a port-reservation?" -> DELETE /port-reservations/{id}
• "List all cancellation-policy?" -> GET /port-reservations/{id}/cancellation-policy
• "List all loa?" -> GET /port-reservations/{id}/loa
• "Create a loa?" -> POST /port-reservations/{id}/loa
• "List all connections?" -> GET /connections
• "Create a connection?" -> POST /connections
• "Get connection details?" -> GET /connections/{id}
• "Update a connection?" -> PUT /connections/{id}
• "Partially update a connection?" -> PATCH /connections/{id}
• "Delete a connection?" -> DELETE /connections/{id}
• "List all statistics?" -> GET /connections/{id}/statistics
• "List all timeseries?" -> GET /connections/{id}/statistics/{aggregate}/timeseries
• "List all loa?" -> GET /connections/{id}/loa
• "Create a loa?" -> POST /connections/{id}/loa
• "List all cancellation-policy?" -> GET /connections/{id}/cancellation-policy
• "List all network-service-configs?" -> GET /network-service-configs
• "Create a network-service-config?" -> POST /network-service-configs
• "Get network-service-config details?" -> GET /network-service-configs/{id}
• "Update a network-service-config?" -> PUT /network-service-configs/{id}
• "Partially update a network-service-config?" -> PATCH /network-service-configs/{id}
• "Delete a network-service-config?" -> DELETE /network-service-configs/{id}
• "List all statistics?" -> GET /network-service-configs/{id}/statistics
• "List all timeseries?" -> GET /network-service-configs/{id}/statistics/{aggregate}/timeseries
• "List all peer-statistics?" -> GET /network-service-configs/{id}/peer-statistics
• "List all timeseries?" -> GET /network-service-configs/{id}/peer-statistics/{aggregate}/timeseries
• "List all cancellation-policy?" -> GET /network-service-configs/{id}/cancellation-policy
• "List all network-feature-configs?" -> GET /network-feature-configs
• "Create a network-feature-config?" -> POST /network-feature-configs
• "Get network-feature-config details?" -> GET /network-feature-configs/{id}
• "Update a network-feature-config?" -> PUT /network-feature-configs/{id}
• "Partially update a network-feature-config?" -> PATCH /network-feature-configs/{id}
• "Delete a network-feature-config?" -> DELETE /network-feature-configs/{id}
• "List all account?" -> GET /account
• "List all accounts?" -> GET /accounts
• "Create a account?" -> POST /accounts
• "Get account details?" -> GET /accounts/{id}
• "Update a account?" -> PUT /accounts/{id}
• "Partially update a account?" -> PATCH /accounts/{id}
• "Delete a account?" -> DELETE /accounts/{id}
• "List all roles?" -> GET /roles
• "Get role details?" -> GET /roles/{id}
• "List all contacts?" -> GET /contacts
• "Create a contact?" -> POST /contacts
• "Get contact details?" -> GET /contacts/{id}
• "Update a contact?" -> PUT /contacts/{id}
• "Partially update a contact?" -> PATCH /contacts/{id}
• "Delete a contact?" -> DELETE /contacts/{id}
• "List all role-assignments?" -> GET /role-assignments
• "Create a role-assignment?" -> POST /role-assignments
• "Get role-assignment details?" -> GET /role-assignments/{id}
• "Delete a role-assignment?" -> DELETE /role-assignments/{id}
• "List all health?" -> GET /health
• "List all implementation?" -> GET /implementation
• "List all extensions?" -> GET /extensions
• "List all ips?" -> GET /ips
• "Create a ip?" -> POST /ips
• "Get ip details?" -> GET /ips/{id}
• "Update a ip?" -> PUT /ips/{id}
• "Partially update a ip?" -> PATCH /ips/{id}
• "List all macs?" -> GET /macs
• "Create a mac?" -> POST /macs
• "Get mac details?" -> GET /macs/{id}
• "Delete a mac?" -> DELETE /macs/{id}
• "List all network-services?" -> GET /network-services
• "Create a network-service?" -> POST /network-services
• "Get network-service details?" -> GET /network-services/{id}
• "Update a network-service?" -> PUT /network-services/{id}
• "Partially update a network-service?" -> PATCH /network-services/{id}
• "Delete a network-service?" -> DELETE /network-services/{id}
• "List all statistics?" -> GET /network-services/{id}/statistics
• "List all timeseries?" -> GET /network-services/{id}/statistics/{aggregate}/timeseries
• "List all rtt-statistics?" -> GET /network-services/{id}/rtt-statistics
• "List all change-request?" -> GET /network-services/{id}/change-request
• "Create a change-request?" -> POST /network-services/{id}/change-request
• "List all cancellation-policy?" -> GET /network-services/{id}/cancellation-policy
• "List all network-features?" -> GET /network-features
• "Get network-feature details?" -> GET /network-features/{id}
• "List all member-joining-rules?" -> GET /member-joining-rules
• "Create a member-joining-rule?" -> POST /member-joining-rules
• "Get member-joining-rule details?" -> GET /member-joining-rules/{id}
• "Update a member-joining-rule?" -> PUT /member-joining-rules/{id}
• "Partially update a member-joining-rule?" -> PATCH /member-joining-rules/{id}
• "Delete a member-joining-rule?" -> DELETE /member-joining-rules/{id}
• "List all routing-functions?" -> GET /routing-functions
• "Create a routing-function?" -> POST /routing-functions
• "Get routing-function details?" -> GET /routing-functions/{id}
• "Partially update a routing-function?" -> PATCH /routing-functions/{id}
• "Delete a routing-function?" -> DELETE /routing-functions/{id}
• "List all cancellation-policy?" -> GET /routing-functions/{id}/cancellation-policy
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP