Skip to main content
Version: 21.04

Rest API (v2)

Overview​

Centreon Web Rest API v2 aims to replace first version.

To start using it, please refer to the dedicated page.

Create a Postman collection from the OpenAPI definition​

In order to manipulate the API more efficiently or just understand how it works, there is nothing more handy than a Postman collection.

Import the OpenAPI definition​

From your workspace, click on the Import button.

image

Go to the Link tab and enter the URL to the OpenAPI definition from GitHub:

https://raw.githubusercontent.com/centreon/centreon/21.04.x/doc/API/centreon-api-v2.1.yaml

image

Click on Continue and tune some of the default parameters:

  • Select only Collection as an import method,
  • Select Example for the Request parameter generation as it will bring more context on path variables or query parameters,
  • Select Tags for the Folder organization as it will arrange the collection as in the documentation.

Then click on Import and wait a few seconds for the process to be done.

image

Add an environment​

To be able to communicate with your platform, the collection will use environment variables to define access information and credentials.

From your workspace, click on the Manage Environments icon.

image

Click on Add and set the variables as below with your platform information:

image

Then click on Add, and select it in the environments list.

The API version is not set in the environment variables. It's more of a collection variable. It can be changed directly in the collection by editing it.

image

In the Variables tab, change the version value to one of "beta", "latest" or "v2".

image

Other variables will be overload by environment variables.

Edit the Login request​

To make the Login request use the previously defined credentials, and retrieve the API token from the response, it needs to be edited.

From the collection, select the Login request from the Authentication folder.

In the Body tab, change the login and password values by the environment variables {{username}} and {{password}} as below:

image

In the Tests tab, add the following code:

pm.test("Status code is 200", function () { pm.response.to.have.status(200); });

const responseJson = pm.response.json();

pm.test("The response has all properties", () => {
pm.expect(responseJson).to.be.an("object");
pm.expect(responseJson.contact.alias).to.eql(pm.environment.get("username"));
pm.expect(responseJson.security.token).to.be.a('string');
});

pm.environment.set("token", responseJson.security.token);

image

Then click on Save or use Ctrl+S shortcut.

Use the API token​

Once saved, Send the Login request.

image

If successful, it will add a new token enviroment variable filled with the token retrieved from login.

image

To use it in all the requests, edit the collection.

image

In the Authorization tab, choose API Key type and fill the Key field with X-AUTH-TOKEN and Value field with {{token}}.

image

Make sure it will be added to Header.

Then click on Update.

Make requests​

Now that a valid token is stored, you can execute requests on other endpoints.

Uncheck unused query parameters or fill them with values, and click on Send.

image

You will notice the token added in the defined header.

If the token expires, just re-execute the Login request to get a new one.