VSXi OpenAPI Swagger

This article provides an OpenAPI (Swagger) specification for the VSXi REST API.

The existing VSXi REST API guide remains the primary reference for understanding the API, including configuration concepts, field descriptions, and usage examples:

https://support.sansay.com/t/83y6b24/vsxi-rest-api-guide-version-11

When should I use this OpenAPI file?

The OpenAPI specification is intended for developers building automation or integrations, especially when working with:

• Dynamic provisioning (e.g., ECS/Kubernetes-based SIP workloads)

• Custom applications integrating with VSXi

• CI/CD pipelines or infrastructure automation

• Programmatic management of trunks, routes, or monitoring data

Unlike traditional documentation, an OpenAPI file is a machine-readable definition of the API that describes endpoints, parameters, and responses in a structured format  .

This enables you to:

• Generate API clients/SDKs in multiple programming languages

• Import the API into tools like Postman or Swagger UI

• Automatically create interactive API documentation

• Build automated testing and validation workflows

Many development tools can consume this file directly to accelerate integration and reduce manual coding effort  .

Do I still need the REST API guide?

Yes.

• The REST API guide explains what the API does and how VSXi concepts work.

• The OpenAPI spec helps you use the API programmatically and efficiently.

They are complementary:

• Use the REST guide for understanding and troubleshooting

• Use the OpenAPI spec for development and automation