Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Understand the API documentation (Swagger)

In this article, you will learn where the API documentation is located and how to use it.

SUMMARY

  • Access the API documentation
  • Description of methods
    • Related to Serenety
    • Related to Yuno
    • Related to Pentest
    • Related to Phisherman

Access the API documentation

  • Connect to the Portal
  • Go to the Documentation menu
  • Click on the API submenu

This will take you to the description of the API call methods, auto-generated by Swagger.

What is Swagger ?  

It is an interface description language used to describe APIs expressed using JSON. Swagger is used with a range of open source software tools to design, create, document and use Web services.

What is Swagger ?

Description of methods

To use a route described by Swagger, use the following url : https://leportail.xmco.fr/api/


The following routes are available:

  • /user : list of users (and details of your account)
  • /profile : list of profiles
  • /company : list of companies (and details of your company
  • /scope : list of scopes
  • /project : list of projects (per product like Serenety, Yuno)
  • /asset : list of assets
  • /action_plan : list of action plan (which can be associated with a scope, a user or an asset)
  • /actionticket : list of action tickets
  • /tracker : list of trackers of your company
  • /markdown/preview : markdown language preview
  • /file : list of files (from your company or your scope)

Related to Serenety

  • /serenetyscope for all Serenety scopes

Related to Yuno

  • /advisory : list of bulletin
  • /tag : associated tags of bulletins
  • /platform : associated platforms of bulletins (eg Java)
  • CVE
    • /cve : see the details of a CVE
    • /vulndb : search for a CVE (by product, vendor or version)
  • CPE
    • /cpename : list of existing CPE technologies
    • /followedcpename : list of CPE technologies monitored by XMCO
    • /followed_vendors : list of vendors monitored by XMCO
  • /watch : everything linked to the watch module
    • /watch/stats/advisories : search for statistics (by type, number or severity of bulletin)

Related to Pentest

  • /pentest : list of pentests
  • /vulnerability : associated vulnerabilities of pentests

Related to Phisherman

  • /phisherman : statistics from phisherman campaign