Is it possible to get a schema, swagger OAS, or a postman collection for all API endpoints?

Completed

Permanently deleted user

January 16, 2021 10:48

• 
• 

Having a JSON schema would make integrating and testing a LOT easier. The webpages are great, and I’ve not yet been successful in trying to “scape” them into a workable format. Is there anything available? Or that could be made available?

0

• 

  Permanently deleted user

  January 17, 2021 01:56

  Hi Luke! 

  It is not available for the existing API, but we have a new REST API with OpenAPI (swagger) schema in baking. 

  The preview will become available in Meta around February-March, and planned to be in production release later this year.

  0
• 

  Permanently deleted user

  January 17, 2021 02:00

  For the existing API a description of methods is available in our legacy format at http://{SERVER IP}:7001/static/api.json, but we know that the format is lacking structure for non-trivial methods.

  0
• 

  francesco cervellera

  March 03, 2022 21:42

  Hello.

  Is there any update on this ?

  Thanks

  0
• 

  Norman

  • Network Optix team

  March 04, 2022 10:28 Edited

  Hi francesco cervellera (and @... of course),

  We are trying to fulfill this request in version 5.0.

  You can have a preview with the 5.0 Beta version and use the following URL to access the server API:

  https://localhost:7001/swagger-ui/openapi_deprecated.json
  https://localhost:7001/swagger-ui/openapi_legacy.json
  https://localhost:7001/swagger-ui/openapi_v1.json

  0
• 

  ST team

  May 08, 2023 12:11

  Hello all,

  Is there a postman collection of the REST api added by any chance?

  0
• 

  Andrey Terentyev

  • Network Optix team

  May 10, 2023 09:36 Edited

  Hi Ido Jaffe ,

  Unfortunately, there isn't.

  0
• 

  Loic Lecuyer

  September 02, 2024 07:22

  Hello,

  The OpenApi description of your Rest API only concerns your API v1 (deprecated), is there an OpenAPi description of your API V2?

  0

Please sign in to leave a comment.