---
title: Understand the API documentation (Swagger)
description: Where the API documentation is located and how to use it.
---

[Skip to content](https://content.xmco.fr/en/base-de-connaissances/understand-api-documentation#main-content)

- [English](https://content.xmco.fr/en/base-de-connaissances/understand-api-documentation)
- [Français](https://content.xmco.fr/fr/base-de-connaissances/comprendre-documentation-api)

English

Show submenu for translations

![](https://content.xmco.fr/hubfs/xmco.svg)

- [View your tickets](https://content.xmco.fr/tickets-view)
- [Log out](https://content.xmco.fr/_hcms/mem/logout)

Open main navigation

Close main navigation

- [View your tickets](https://content.xmco.fr/tickets-view)
- [Log out](https://content.xmco.fr/_hcms/mem/logout)
- - [English](https://content.xmco.fr/en/base-de-connaissances/understand-api-documentation)
    - [Français](https://content.xmco.fr/fr/base-de-connaissances/comprendre-documentation-api)

  English
  
  Show submenu for translations
- [Contact support](https://content.xmco.fr/en/support)

[Contact support](https://content.xmco.fr/en/support?hsLang=en)

 How can we help you?

- There are no suggestions because the search field is empty.

1. [Base de connaissances](https://content.xmco.fr/en/base-de-connaissances?hsLang=en)
2. [Use the API and connectors](https://content.xmco.fr/en/base-de-connaissances/use-the-api-and-connectors?hsLang=en)
3. [Understanding and using the Portal API](https://content.xmco.fr/en/base-de-connaissances/use-the-api-and-connectors?hsLang=en#understanding-and-using-the-portal-api)

# 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

![](https://content.xmco.fr/hs-fs/hubfs/Knowledge%20Base%20Import/kZyJupjx6wJRUf2eUQ9AZ-HVk2rajkcKcw.png?width=852&height=498&name=kZyJupjx6wJRUf2eUQ9AZ-HVk2rajkcKcw.png)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 ?**  
![](https://content.xmco.fr/hs-fs/hubfs/Knowledge%20Base%20Import/_hNriDgbe9czxEnDuT0Ra0Gnd7eL5-ypQg-1.png?width=3422&height=1106&name=_hNriDgbe9czxEnDuT0Ra0Gnd7eL5-ypQg-1.png)

### Description of methods

To use a route described by Swagger, use the following url : [https://leportail.xmco.fr/api/](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

- [Set up your account and company](https://content.xmco.fr/en/base-de-connaissances/set-up-your-account-and-company?hsLang=en#main-content)

    - [Log in](https://content.xmco.fr/en/base-de-connaissances/set-up-your-account-and-company?hsLang=en#log-in)
    - [Integrate your SSO](https://content.xmco.fr/en/base-de-connaissances/set-up-your-account-and-company?hsLang=en#integrate-your-sso)
    - [Manage your account](https://content.xmco.fr/en/base-de-connaissances/set-up-your-account-and-company?hsLang=en#manage-your-account)
    - [Manage your company](https://content.xmco.fr/en/base-de-connaissances/set-up-your-account-and-company?hsLang=en#manage-your-company)
- [Discover the Serenety module](https://content.xmco.fr/en/base-de-connaissances/discover-the-serenety-module?hsLang=en#main-content)

    - [Documentation Serenety](https://content.xmco.fr/en/base-de-connaissances/discover-the-serenety-module?hsLang=en#documentation-serenety)
    - [Set up Serenety in just a few clicks](https://content.xmco.fr/en/base-de-connaissances/discover-the-serenety-module?hsLang=en#set-up-serenety-in-just-a-few-clicks)
    - [Serenety key features](https://content.xmco.fr/en/base-de-connaissances/discover-the-serenety-module?hsLang=en#serenety-key-features)
- [Discover Yuno](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#main-content)

    - [Set up Yuno in just a few clicks](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#set-up-yuno-in-just-a-few-clicks)
    - [Advanced settings](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#advanced-settings)
    - [Yuno's main pages](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#yunos-main-pages)
    - [FAQ](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#faq)
    - [Download the complete documentation](https://content.xmco.fr/en/base-de-connaissances/discover-yuno?hsLang=en#download-the-complete-documentation)
- [Use the API and connectors](https://content.xmco.fr/en/base-de-connaissances/use-the-api-and-connectors?hsLang=en#main-content)

    - [Understanding and using the Portal API](https://content.xmco.fr/en/base-de-connaissances/use-the-api-and-connectors?hsLang=en#understanding-and-using-the-portal-api)
    - [Connect to our Portal](https://content.xmco.fr/en/base-de-connaissances/use-the-api-and-connectors?hsLang=en#connect-to-our-portal)
- [Legal information](https://content.xmco.fr/en/base-de-connaissances/legal-information?hsLang=en)

[![](https://content.xmco.fr/hubfs/xmco.svg)](https://www.xmco.fr)

[mailto:support@xmco.fr](mailto:support@xmco.fr) <https://www.linkedin.com/company/xmco>

Copyright © 2026, XMCO