Air APIAPI ReferenceSimulations

Parse topology between different formats

View as Markdown

Convert topology data between different formats (e.g., DOT to JSON). This is a utility endpoint for validating and converting topology formats.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
source_formatenumRequired

Topology format to parse the topology from.

  • DOT - DOT (graphvis) format
destination_formatenumRequired

Topology format to parse the topology to.

  • JSON - JSON format
topology_datastringRequired>=1 character

Topology content which matches the format specified in source_format.

Response

source_formatenum

Topology format to parse the topology from.

  • DOT - DOT (graphvis) format
destination_formatenum

Topology format to parse the topology to.

  • JSON - JSON format
topology_datastring

Topology content which matches the format specified in source_format.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error