GLPI

https://github.com/glpi-project/glpi
Admin
GLPI is a Free Asset and IT Management Software package that provides ITIL Service Desk features,...
Tokens:731,402
Snippets:5,243
Trust Score:9.7
License:GPL-3.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install GLPI dependencies with composer and npm

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/INSTALL.md

Run this command in the GLPI directory after installing composer and npm to install all third-party libraries required for the source code version.

```bash
$ php bin/console dependencies install
```

--------------------------------

### Install e2e database with make

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/e2e/README.md

Run this command to install the e2e database when using the official GLPI development docker image.

```sh
make e2e-db-install
```

--------------------------------

### CURL request to get massive actions for Computer/3

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Sends a GET request to apirest.php/getMassiveActions/Computer/3 with Session-Token and App-Token headers. Returns a 200 OK response listing available massive actions for the item.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActions/Computer/3'

< 200 OK
[
  {
    "key": "MassiveAction:update",
    "label": "Update"
  },
  {
    "key": "MassiveAction:clone",
    "label": "Clone"
  },
  {
    "key": "Infocom:activate",
    "label": "Enable the financial and administrative information"
  },
  {
    "key": "MassiveAction:delete",
    "label": "Put in trashbin"
  },
  {
    "key": "Appliance:add_item",
    "label": "Associate to an appliance"
  },
  {
    "key": "Item_OperatingSystem:update",
    "label": "Operating systems"
  },
  {
    "key": "Glpi\\Asset\\Asset_PeripheralAsset:add",
    "label": "Connect"
  },
  {
    "key": "Item_SoftwareVersion:add",
    "label": "Install"
  },
  {
    "key": "KnowbaseItem_Item:add",
    "label": "Link knowledgebase article"
  },
  {
    "key": "Document_Item:add",
    "label": "Add a document"
  },
  {
    "key": "Document_Item:remove",
    "label": "Remove a document"
  },
  {
    "key": "Contract_Item:add",
    "label": "Add a contract"
  },
  {
    "key": "Contract_Item:remove",
    "label": "Remove a contract"
  },
  {
    "key": "MassiveAction:amend_comment",
    "label": "Amend comment"
  },
  {
    "key": "MassiveAction:add_note",
    "label": "Add note"
  },
  {
    "key": "Lock:unlock",
    "label": "Unlock components"
  }
]
```

--------------------------------

### CURL request to get massive actions for Computer/4

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Sends a GET request to apirest.php/getMassiveActions/Computer/4 with the same headers. Returns a 200 OK response with a different set of massive actions, including purge and restore options.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActions/Computer/4'

< 200 OK
[
  {
    "key": "MassiveAction:purge_item_but_devices",
    "label": "Delete permanently but keep devices"
  },
  {
    "key": "MassiveAction:purge",
    "label": "Delete permanently and remove devices"
  },
  {
    "key": "MassiveAction:restore",
    "label": "Restore"
  },
  {
    "key": "Lock:unlock",
    "label": "Unlock components"
  }
]
```

--------------------------------

### Search items example usage (CURL)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example CURL command to search Monitor items using the GLPI API. It uses the 'search' endpoint with criteria for fields 23 (contains 'GSM') and 1 (contains 'W2'), and requests a range of 0-2. The response headers show Content-Range and Accept-Range, and the response body contains the matching items.

```bash
curl -g -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/search/Monitor?\
criteria\[0\]\[link\]\=AND\
\&criteria\[0\]\[itemtype\]\=Monitor\
\&criteria\[0\]\[field\]\=23\
\&criteria\[0\]\[searchtype\]\=contains\
\&criteria\[0\]\[value\]\=GSM\
\&criteria\[1\]\[link\]\=AND\
\&criteria\[1\]\[itemtype\]\=Monitor\
\&criteria\[1\]\[field\]\=1\
\&criteria\[1\]\[searchtype\]\=contains\
\&criteria\[1\]\[value\]\=W2\
\&range\=0-2\&&forcedisplay\[0\]\=1'
```

```http
< 200 OK
< Content-Range: 0-2/2
< Accept-Range: 990
< {"totalcount":2,"count":2,"data":{"11":{"1":"W2242","80":"Root Entity","23":"GSM"},"7":{"1":"W2252","80":"Root Entity","23":"GSM"}}}%
```

--------------------------------

### Install Playwright browsers without docker

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/e2e/README.md

Install Chromium browser and its dependencies for running tests without docker.

```sh
npx playwright install chromium
```

```sh
sudo npx playwright install-deps chromium
```

--------------------------------

### Create dedicated test database

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/README.md

Use the database:install CLI command with --env=testing to create a new database for the test suite. The configuration file is saved as tests/config/config_db.php. Use --force to recreate the database.

```bash
$ bin/console database:install --env=testing --db-name=glpitests --db-user=root --db-password=xxxx
Creating the database...
Saving configuration file...
Loading default schema...
Installation done.
```

--------------------------------

### Search items criteria JSON example

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example of the 'criteria' query parameter for the search endpoint. Each criterion can be a direct searchoption (with field, searchtype, value) or a nested criteria list. The 'meta' flag allows searching on another itemtype.

```json
{
   "criteria":
      [
         {
            "field":      1,
            "searchtype": 'contains',
            "value":      ''
         }, {
            "link":       'AND',
            "field":      31,
            "searchtype": 'equals',
            "value":      1
         }, {
            "link":       'AND',
            "meta":       true,
            "itemtype":   'User',
            "field":      1,
            "searchtype": 'equals',
            "value":      1
         }, {
            "link":       'AND',
            "criteria" : [
               {
                  "field":      34,
                  "searchtype": 'equals',
                  "value":      1
               }, {
                  "link":       'OR',
                  "field":      35,
                  "searchtype": 'equals',
                  "value":      1
               }
            ]
         }
      ]
}
```

--------------------------------

### Search items metacriteria JSON example

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example of the deprecated 'metacriteria' query parameter. Each meta-criterion links to another itemtype (e.g., Monitor) and requires a mandatory 'link' operator.

```json
{
   "metacriteria":
      [
         {
            "link":       'AND',
            "itemtype":   'Monitor',
            "field":      2,
            "searchtype": 'contains',
            "value":      ''
         }, {
            "link":       'AND',
            "itemtype":   'Monitor',
            "field":      3,
            "searchtype": 'contains',
            "value":      ''
          }
      ]
}
```

--------------------------------

### Nginx server configuration for GLPI API

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example Nginx configuration for GLPI with PHP-FPM, including URL rewriting for /api to apirest.php. Adjust root and fastcgi_pass paths as needed.

```nginx
server {
   listen 80 default_server;
   listen [::]:80 default_server;

   # change here to match your GLPI directory
   root /var/www/html/glpi/;

   index index.html index.htm index.nginx-debian.html index.php;

   server_name localhost;

   location / {
      try_files $uri $uri/ =404;
      autoindex on;
   }

   location /api {
      rewrite ^/api/(.*)$ /apirest.php/$1 last;
   }

   location ~ [^/]\.php(/|$) {
      fastcgi_pass unix:/run/php/php7.0-fpm.sock;

      # regex to split $uri to $fastcgi_script_name and $fastcgi_path
      fastcgi_split_path_info ^(.+\.php)(/.+)$;

      # Check that the PHP script exists before passing it
      try_files $fastcgi_script_name =404;

      # Bypass the fact that try_files resets $fastcgi_path_info
      # # see: http://trac.nginx.org/nginx/ticket/321
      set $path_info $fastcgi_path_info;
      fastcgi_param  PATH_INFO $path_info;

      fastcgi_param  PATH_TRANSLATED    $document_root$fastcgi_script_name;
      fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;

      include fastcgi_params;

      # allow directory index
      fastcgi_index index.php;
   }
}
```

--------------------------------

### GET /api.php/doc

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/resources/api_doc.MD

Retrieves the Swagger documentation for the GLPI API. You can get the raw Swagger JSON by setting the Content-Type header to application/json or adding .json to the URL.

```APIDOC
## GET /api.php/doc

### Description
Retrieves the Swagger documentation for the GLPI API. You can get the raw Swagger JSON by setting the Content-Type header to application/json or adding .json to the URL.

### Method
GET

### Endpoint
/api.php/doc

### Parameters
#### Query Parameters
- **.json** (string) - Optional - Append .json to the URL to get the raw Swagger JSON.

### Request Example
GET /api.php/doc.json

### Response
#### Success Response (200)
- **Swagger JSON** (object) - The Swagger documentation in JSON format.

#### Response Example
{
  "swagger": "2.0",
  "info": {},
  "paths": {}
}
```

--------------------------------

### Response for getMassiveActions with is_deleted=1

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example 200 OK response listing massive actions available for items in the trashbin (is_deleted=1). Includes purge, restore, and unlock actions.

```json
< 200 OK
[
  {
    "key": "MassiveAction:purge_item_but_devices",
    "label": "Delete permanently but keep devices"
  },
  {
    "key": "MassiveAction:purge",
    "label": "Delete permanently and remove devices"
  },
  {
    "key": "MassiveAction:restore",
    "label": "Restore"
  },
  {
    "key": "Lock:unlock",
    "label": "Unlock components"
  }
]
```

--------------------------------

### Get an item with CURL

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Retrieves a Computer item (id 71) with expand_dropdowns=true. Requires a valid Session-Token and App-Token. The response includes the item fields and HATEOAS links.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/Computer/71?expand_dropdowns=true'
```

```http
< 200 OK
< {
    "id": 71,
    "entities_id": "Root Entity",
    "name": "adelaunay-ThinkPad-Edge-E320",
    "serial": "12345",
    "otherserial": "test2",
    "contact": "adelaunay",
    "contact_num": null,
    "users_id_tech": " ",
    "groups_id_tech": " ",
    "comment": "test222222qsdqsd",
    "date_mod": "2015-09-25 09:33:41",
    "autoupdatesystems_id": " ",
    "locations_id": "00:0e:08:3b:7d:04",
    "networks_id": " ",
    "computermodels_id": "1298A8G",
    "computertypes_id": "Notebook",
    "is_template": 0,
    "template_name": null,
    "manufacturers_id": "LENOVO",
    "is_deleted": 0,
    "is_dynamic": 1,
    "users_id": "adelaunay",
    "groups_id": " ",
    "states_id": "Production",
    "ticket_tco": "0.0000",
    "uuid": "",
    "date_creation": null,
    "links": [{
       "rel": "Entity",
       "href": "http://path/to/glpi/api/Entity/0"
    }, {
       "rel": "Location",
       "href": "http://path/to/glpi/api/Location/3"
    }, {
       "rel": "Domain",
       "href": "http://path/to/glpi/api/Domain/18"
    }, {
       "rel": "ComputerModel",
       "href": "http://path/to/glpi/api/ComputerModel/11"
    }, {
       "rel": "ComputerType",
       "href": "http://path/to/glpi/api/ComputerType/3"
    }, {
       "rel": "Manufacturer",
       "href": "http://path/to/glpi/api/Manufacturer/260"
    }, {
       "rel": "User",
       "href": "http://path/to/glpi/api/User/27"
    }, {
       "rel": "State",
       "href": "http://path/to/glpi/api/State/1"
    }]
}
```

--------------------------------

### Get Active Entities - CURL Example

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Retrieves the active entity and its sub-entities for the current logged-in user. Requires a valid Session-Token header; App-Token is optional. Returns a 200 OK response with an array containing active_entity, active_entity_recursive, and active_entities.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getActiveEntities'

< 200 OK
< {
   'active_entity': {
      'id': 1,
      'active_entity_recursive': true,
      'active_entities': [
        {"id":1},
        {"id":71},...
      ]
   }
}
```

--------------------------------

### CURL request to get massive actions for an itemtype

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

GET request to apirest.php/getMassiveActions/:itemtype/ with Session-Token and App-Token headers. Returns 200 OK with a list of available massive actions for the given itemtype (e.g., Computer).

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActions/Computer'
```

--------------------------------

### Get my entities with CURL (GET getMyEntities)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Sends a GET request to getMyEntities to retrieve all entities available to the current user for the active profile. Requires a valid Session-Token header; App-Token is optional. Returns 200 OK with an array of entities (id and name) or 400 for invalid input.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMyEntities'

< 200 OK
< {
   'myentities': [
     {
       'id':   71
       'name': "my_entity"
     },
   ....
   ]
  }
```

--------------------------------

### Test: Create a computer with the API

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/e2e/README.md

Uses the api fixture to create a Computer item via the API, then navigates to the form and verifies the name field. Faster than manual UI setup.

```TypeScript
test('create a computer with the API', async ({page, profile, api}) => {
    const computer_name = `My computer ${randomUUID()}`;
    const id = await api.createItem("Computer", {
        name: computer_name,
        is_recursive: true,
    });

    await profile.set(Profiles.SuperAdmin);
    await page.goto(`/front/computer.form.php?id=${id}`);
    const name_input = page.getByRole('main').getByRole('textbox', {
        name: "Name",
        exact: true
    });
    await expect(name_input).toHaveValue(computer_name);
});
```

--------------------------------

### Download a document file with alt=media parameter (CURL)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Downloads a document by sending a GET request with the 'alt=media' query parameter. The 'id' parameter can be passed in the input payload. The response body contains the raw file attached to the document.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
-d '{"input": {"id": 11}}' \
'http://path/to/glpi/apirest.php/Document/&alt=media'

< 200 OK
```

--------------------------------

### GET apirest.php/initSession/

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Requests a session token to use other API endpoints. Authentication can be done via HTTP basic auth (login/password) or a user token, with an optional App-Token header.

```APIDOC
## [GET] apirest.php/initSession/

### Description
Request a session token to uses other API endpoints.

### Method
GET

### Endpoint
apirest.php/initSession/

### Parameters
#### Headers
- **App-Token** (string) - Optional - Authorization string provided by the GLPI API configuration.
- **Authorization** (string) - Required - Either HTTP basic auth (Base64 of login:password) or a user token (format: `user_token <token>`).

#### Query Parameters
- **get_full_session** (boolean) - Optional - Default: false. Get the full session, useful if you want to login and access session data in one request.

### Request Example
```bash
curl -X GET \
-H 'Content-Type: application/json' \
-H "Authorization: Basic Z2xwaTpnbHBp" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/initSession'
```

### Response
#### Success Response (200)
- **session_token** (string) - The session token to use in subsequent API requests.
- **session** (object) - Optional, present when `get_full_session=true`. Contains full session data.

#### Response Example
```json
{
  "session_token": "83af7e620c83a50a18d3eac2f6ed05a3ca0bea62"
}
```

#### Error Responses
- **400** (Bad Request) - A message indicating an error in input parameter.
- **401** (UNAUTHORIZED) - Authentication failed.
```

--------------------------------

### Response for getMassiveActions without is_deleted

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Example 200 OK response listing available massive actions for the Computer itemtype when is_deleted is not set (default false). Includes actions like update, clone, delete, and various associations.

```json
< 200 OK
[
  {
    "key": "MassiveAction:update",
    "label": "Update"
  },
  {
    "key": "MassiveAction:clone",
    "label": "Clone"
  },
  {
    "key": "Infocom:activate",
    "label": "Enable the financial and administrative information"
  },
  {
    "key": "MassiveAction:delete",
    "label": "Put in trashbin"
  },
  {
    "key": "Appliance:add_item",
    "label": "Associate to an appliance"
  },
  {
    "key": "Item_OperatingSystem:update",
    "label": "Operating systems"
  },
  {
    "key": "Glpi\\Asset\\Asset_PeripheralAsset:add",
    "label": "Connect"
  },
  {
    "key": "Item_SoftwareVersion:add",
    "label": "Install"
  },
  {
    "key": "KnowbaseItem_Item:add",
    "label": "Link knowledgebase article"
  },
  {
    "key": "Document_Item:add",
    "label": "Add a document"
  },
  {
    "key": "Document_Item:remove",
    "label": "Remove a document"
  },
  {
    "key": "Contract_Item:add",
    "label": "Add a contract"
  },
  {
    "key": "Contract_Item:remove",
    "label": "Remove a contract"
  },
  {
    "key": "MassiveAction:amend_comment",
    "label": "Amend comment"
  },
  {
    "key": "MassiveAction:add_note",
    "label": "Add note"
  },
  {
    "key": "Lock:unlock",
    "label": "Unlock components"
  }
]
```

--------------------------------

### Download a document file with Accept header (CURL)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Downloads a document by sending a GET request with the 'Accept: application/octet-stream' header. The 'id' parameter can be passed in the input payload. The response body contains the raw file attached to the document.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
-H "Accept: application/octet-stream" \
-d '{"input": {"id": 11}}' \
'http://path/to/glpi/apirest.php/Document/'

< 200 OK
```

--------------------------------

### GET /api.php/GraphQL/Schema

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/resources/api_doc.MD

REST API interface for retrieving the raw GraphQL type declarations. This is useful for exploring the available schemas.

```APIDOC
## GET /api.php/GraphQL/Schema

### Description
REST API interface for retrieving the raw GraphQL type declarations. This is useful for exploring the available schemas.

### Method
GET

### Endpoint
/api.php/GraphQL/Schema

### Parameters
None

### Request Example
GET /api.php/GraphQL/Schema

### Response
#### Success Response (200)
- **Schema** (object) - The GraphQL schema definition.

#### Response Example
{
  "types": [
    {
      "name": "Ticket",
      "fields": []
    }
  ]
}
```

--------------------------------

### CURL request to get all items

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Use this CURL command to retrieve a collection of items of a given itemtype (e.g., Computer). It requires a valid Session-Token and optionally an App-Token. The response includes a 206 status with Content-Range and Accept-Range headers, and the body contains item data with expanded dropdowns when expand_dropdowns=true.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/Computer/?expand_dropdowns=true'

< 206 OK
< Content-Range: 0-49/200
< Accept-Range: 990
< [
   {
      "id": 34,
      "entities_id": "Root Entity",
      "name": "glpi",
      "serial": "VMware-42 01 f4 65 27 59 a9 fb-11 bc cd b8 64 68 1f 4b",
      "otherserial": null,
      "contact": "teclib",
      "contact_num": null,
      "users_id_tech": "&nbsp;",
      "groups_id_tech": "&nbsp;",
      "comment": "x86_64/00-09-15 08:03:28",
      "date_mod": "2011-12-16 17:52:55",
      "autoupdatesystems_id": "FusionInventory",
      "locations_id": "&nbsp;",
      "networks_id": "&nbsp;",
      "computermodels_id": "VMware Virtual Platform",
      "computertypes_id": "Other",
      "is_template": 0,
      "template_name": null,
      "manufacturers_id": "VMware, Inc.",
      "is_deleted": 0,
      "is_dynamic": 1,
      "users_id": "&nbsp;",
      "groups_id": "&nbsp;",
      "states_id": "Production",
      "ticket_tco": "0.0000",
      "uuid": "4201F465-2759-A9FB-11BC-CDB864681F4B",
      "links": [{
         "rel": "Entity",
         "href": "http://path/to/glpi/api/Entity/0"
      }, {
         "rel": "AutoUpdateSystem",
         "href": "http://path/to/glpi/api/AutoUpdateSystem/1"
      }, {
         "rel": "Domain",
         "href": "http://path/to/glpi/api/Domain/12"
      }, {
         "rel": "ComputerModel",
         "href": "http://path/to/glpi/api/ComputerModel/1"
      }, {
         "rel": "ComputerType",
         "href": "http://path/to/glpi/api/ComputerType/2"
      }, {
         "rel": "Manufacturer",
         "href": "http://path/to/glpi/api/Manufacturer/1"
      }, {
         "rel": "State",
         "href": "http://path/to/glpi/api/State/1"
      }]
   },
   {
      "id": 35,
      "entities_id": "Root Entity",
      "name": "mavm1",
      "serial": "VMware-42 20 d3 04 ac 49 ed c8-ea 15 50 49 e1 40 0f 6c",
      "otherserial": null,
      "contact": "teclib",
      "contact_num": null,
      "users_id_tech": "&nbsp;",
      "groups_id_tech": "&nbsp;",
      "comment": "x86_64/01-01-04 19:50:40",
      "date_mod": "2012-05-24 06:43:35",
      ...
   }
]
```

--------------------------------

### CURL request with is_deleted=1

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

GET request to apirest.php/getMassiveActions/Computer?is_deleted=1 to show actions specific to items in the trashbin. Returns 200 OK with a different set of massive actions.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActions/Computer?is_deleted=1'
```

--------------------------------

### GET /api.php/authorize

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/resources/api_doc.MD

Initiate the OAuth2 authorization code flow. This endpoint redirects the user to the GLPI login page and, upon successful authentication, redirects back to the client with a code parameter.

```APIDOC
## GET /api.php/authorize

### Description
Initiate the OAuth2 authorization code flow. This endpoint redirects the user to the GLPI login page and, upon successful authentication, redirects back to the client with a code parameter.

### Method
GET

### Endpoint
/api.php/authorize

### Parameters
#### Query Parameters
- `response_type` (string) - Required - Must be `code`.
- `client_id` (string) - Required - The client ID of the client you are using.
- `scope` (string) - Required - The scope of the request. The client must be allowed to use the requested scope.

### Request Example
GET /api.php/authorize?response_type=code&client_id=your_client_id&scope=api

### Response
#### Success Response (302 Redirect)
- Redirects to the GLPI login page. After successful authentication, redirects back to the client with a `code` parameter in the query string.
```

--------------------------------

### Get a user's profile picture (CURL)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Retrieves a user's profile picture by sending a GET request to the User/:id/Picture endpoint. The response body contains the raw image. Returns 204 No Content if the user has no profile picture.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/User/2/Picture/'

< 200 OK
```

--------------------------------

### Get full session with CURL

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

CURL request to the getFullSession endpoint. Requires a valid Session-Token header; App-Token is optional. Returns 200 OK with the PHP session array or 400 on invalid input.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getFullSession'

< 200 OK
< {
      'session': {
         'glpi_plugins': ...,
         'glpicookietest': ...,
         ...
      }
   }
```

--------------------------------

### Get massive action parameters (CURL)

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Shows available parameters for a massive action. The endpoint is experimental and some required parameters may be missing. Returns 200 OK with a JSON array of parameter definitions, or 400/401 on errors.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActionParameters/Computer/MassiveAction:add_note'

< 200 OK
[
  {
    "name": "add_note",
    "type": "text"
  }
]
```

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMassiveActionParameters/Computer/Contract_Item:add'

< 200 OK
[
  {
    "name": "peer_contracts_id",
    "type": "dropdown"
  }
]
```

--------------------------------

### Basic GraphQL query for Ticket with filter and limit

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/resources/api_doc.MD

Query the Ticket schema with a limit of 1 and a filter on the name field using the 'ilike' operator. The response includes the id, name, and nested status object with its id and name. This example demonstrates the basic query structure and the requirement to specify each property you want returned.

```graphql
query {
    Ticket(limit: 1, filter: "name=ilike=test") {
        id
        name
        status {
            id
            name
        }
    }
}
```

--------------------------------

### Get GLPI config with CURL

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

CURL request to the getGlpiConfig endpoint. Requires a valid Session-Token header; App-Token is optional. Returns 200 OK with the $CFG_GLPI array or 400 on invalid input.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getGlpiConfig'

< 200 OK
< {
      'cfg_glpi': {
         'languages': ...,
         'glpitables': ...,
         'unicity_types':...,
         ...
      }
   }
```

--------------------------------

### Set expected profile

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/e2e/README.md

Sets the profile to SuperAdmin. This is mandatory because each thread reuses a single GLPI session and the current profile is unknown at test start.

```TypeScript
await profile.set(Profiles.SuperAdmin);
```

--------------------------------

### GET apirest.php/killSession

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Destroys a session identified by a session token. This endpoint is used to terminate a user session.

```APIDOC
## [GET] apirest.php/killSession

### Description
Destroys a session identified by a session token.

### Method
GET

### Endpoint
apirest.php/killSession

### Parameters
#### Headers
- **Session-Token** (string) - Required - Session token provided by the initSession endpoint.
- **App-Token** (string) - Optional - Authorization string provided by the GLPI API configuration.

### Request Example
```bash
curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/killSession'
```

### Response
#### Success Response (200)
- 200 (OK)

#### Error Response (400)
- 400 (Bad Request) with a message indicating an error in input parameter.

```

--------------------------------

### GET /apirest.php/:itemtype/

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Returns a collection of rows of the specified itemtype. Supports pagination, sorting, filtering, and optional expansions.

```APIDOC
## [GET] /apirest.php/:itemtype/

### Description
Return a collection of rows of the itemtype.

### Method
GET

### Endpoint
/apirest.php/:itemtype/

### Parameters
#### Headers
- **Session-Token** (string) - Required - Session variable provided by the initSession endpoint.
- **App-Token** (string) - Optional - Authorization string provided by the GLPI API configuration.

#### Query Parameters
- **expand_dropdowns** (boolean) - Optional - Show dropdown name instead of id. Default: false.
- **get_hateoas** (boolean) - Optional - Show relation of item in a links attribute. Default: true.
- **only_id** (boolean) - Optional - Keep only id keys in returned data. Default: false.
- **range** (string) - Optional - A string with a couple of numbers for start and end of pagination separated by a '-'. Ex: 150-199. Default: 0-49.
- **sort** (string) - Optional - Name of the field to sort by. Default: 1.
- **order** (string) - Optional - ASC - Ascending sort / DESC Descending sort. Default: ASC.
- **searchText** (array) - Optional - Array of filters to pass on the query (with key = field and value the text to search). Default: NULL.
- **is_deleted** (boolean) - Optional - Return deleted element. Default: false.
- **add_keys_names** (array) - Optional - Retrieve friendly names. Array containing fkey(s) and/or "id".
- **with_networkports** (boolean) - Optional - Retrieve all network connections and advanced information.

### Request Example
```bash
curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/Computer/?expand_dropdowns=true'
```

### Response
#### Success Response (200)
- **items** (array) - Collection of item objects.

#### Success Response (206)
- **items** (array) - Collection of item objects defined by range.

#### Response Example
```json
[
   {
      "id": 34,
      "entities_id": "Root Entity",
      "name": "glpi",
      "serial": "VMware-42 01 f4 65 27 59 a9 fb-11 bc cd b8 64 68 1f 4b",
      "otherserial": null,
      "contact": "teclib",
      "contact_num": null,
      "users_id_tech": "&nbsp;",
      "groups_id_tech": "&nbsp;",
      "comment": "x86_64/00-09-15 08:03:28",
      "date_mod": "2011-12-16 17:52:55",
      "autoupdatesystems_id": "FusionInventory",
      "locations_id": "&nbsp;",
      "networks_id": "&nbsp;",
      "computermodels_id": "VMware Virtual Platform",
      "computertypes_id": "Other",
      "is_template": 0,
      "template_name": null,
      "manufacturers_id": "VMware, Inc.",
      "is_deleted": 0,
      "is_dynamic": 1,
      "users_id": "&nbsp;",
      "groups_id": "&nbsp;",
      "states_id": "Production",
      "ticket_tco": "0.0000",
      "uuid": "4201F465-2759-A9FB-11BC-CDB864681F4B",
      "links": [{
         "rel": "Entity",
         "href": "http://path/to/glpi/api/Entity/0"
      }, {
         "rel": "AutoUpdateSystem",
         "href": "http://path/to/glpi/api/AutoUpdateSystem/1"
      }, {
         "rel": "Domain",
         "href": "http://path/to/glpi/api/Domain/12"
      }, {
         "rel": "ComputerModel",
         "href": "http://path/to/glpi/api/ComputerModel/1"
      }, {
         "rel": "ComputerType",
         "href": "http://path/to/glpi/api/ComputerType/2"
      }, {
         "rel": "Manufacturer",
         "href": "http://path/to/glpi/api/Manufacturer/1"
      }, {
         "rel": "State",
         "href": "http://path/to/glpi/api/State/1"
      }]
   },
   {
      "id": 35,
      "entities_id": "Root Entity",
      "name": "mavm1",
      "serial": "VMware-42 20 d3 04 ac 49 ed c8-ea 15 50 49 e1 40 0f 6c",
      "otherserial": null,
      "contact": "teclib",
      "contact_num": null,
      "users_id_tech": "&nbsp;",
      "groups_id_tech": "&nbsp;",
      "comment": "x86_64/01-01-04 19:50:40",
      "date_mod": "2012-05-24 06:43:35",
      ...
   }
]
```

### Error Handling
- **401** (UNAUTHORIZED) - Authentication failed.

```

--------------------------------

### Get My Profiles - CURL request and response

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Retrieves all profiles associated with the logged-in user. Requires a valid Session-Token header; App-Token is optional. Returns 200 OK with an array of profiles or 400 Bad Request on invalid input. The response shows the 'myprofiles' array containing profile objects with id, name, and entities.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getMyProfiles'

< 200 OK
< {
   'myprofiles': [
      {
         'id': 1
         'name': "Super-admin",
         'entities': [
            ...
         ],
         ...
      },
      ....
   ]
```

--------------------------------

### GraphQL query crossing schemas for CartridgeItem with printer_models

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/resources/api_doc.MD

Query the CartridgeItem schema and access the nested printer_models object. The comment notes that the product_number is not usually returned by the REST API but is available in GraphQL because you can access the full PrinterModel schema. This example shows how GraphQL can reduce the number of API requests by accessing more properties.

```graphql
query {
    CartridgeItem {
        id
        name
         printer_models {
            name
            # the product number is not usually returned by the REST API, but is available in GraphQL since you can access the full PrinterModel schema here.
            product_number
        }
    }
}
```

--------------------------------

### Get Active Profile - CURL request and response

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/apirest.md

Retrieves the current active profile for the logged-in user. Requires a valid Session-Token header; App-Token is optional. Returns 200 OK with the profile object or 400 Bad Request on invalid input. The response shows the profile's name and entities.

```bash
$ curl -X GET \
-H 'Content-Type: application/json' \
-H "Session-Token: 83af7e620c83a50a18d3eac2f6ed05a3ca0bea62" \
-H "App-Token: f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7" \
'http://path/to/glpi/apirest.php/getActiveProfile'

< 200 OK
< {
      'name': "Super-admin",
      'entities': [
         ...
      ]
   }
```

--------------------------------

### Execute all tests with make

Source: https://github.com/glpi-project/glpi/blob/12.0/bugfixes/tests/e2e/README.md

Run all E2E tests using the make command.

```sh
make playwright
```
Tokens:
Raw