OpenAPI specifications
All API endpoints are fully described using OpenAPI, and we offer a Swagger editor preloaded with the specification for easy testing.
Table of contents
Availability
Not all APIs might be available, depending on the available features and rights of the API user. The API can return a 404 Not Found if a specific feature is not enabled.
Specifications
| API | Description | Swagger UI | OpenAPI file |
|---|---|---|---|
| Customer | Used to manage customers and customer accounts. | customer-v1 | customer-v1.yml |
| Direct orders | Used for direct product ordering and details (such as colocation services) | direct-order-v1 | direct-order-v1.yml |
| IP management | Used to manage IP allocations of user lines | ip-mgmt-v1 | ip-mgmt-v1.yml |
| Invoice | Used to retrieve account invoices | invoice-v1 | invoice-v1.yml |
| Line | Used to manage user lines | line-v1 | line-v1.yml |
| Line availability | Used to retrieve available packages on a specific location (postal code based) | ac-v2 | ac-v2.yml |
| Line order | Used for access line orders | order-v1 | order-v1.yml |
| Line order information | Used to retrieve more information for access lines orders | line-order-v1 | line-order-v1.yml |
| Line quotation | Used to request new and query current quotations for access lines | line-quotation-v1 | line-quotation-v1.yml |
| Mailing list subscription | Used to manage to manage mailing list subscriptions. | mailing-list | mailing-list.yml |
| Portal messages | Used to convey messages to users using the portal | portal-messages | portal-messages.yml |