# API-referentie voor componenten

Source: https://instatus.com/help/nl/api/components

## Alle componenten van je statuspagina ophalen

**Endpoint:**

```bash
GET /v2/:page_id/components?page=:page&per_page=:per_page
```

- Het standaard paginanummer is 1.
- De standaardwaarde voor per_page is 50; het maximum is 100 items per pagina.

**Voorbeeldrespons:**

```json
[
  {
    "id": "ckf01fvnxywz60a35wdbn5gz5",
    "name": "App",
    "status": "OPERATIONAL",
    "uniqueEmail": "nasa-app-1nozrueut@automation.instatus.com",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null
  },
  {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website",
    "status": "OPERATIONAL",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null,
    "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com"
  }
]
```

## Een component ophalen

**Endpoint:**

```bash
GET /v2/:page_id/components/:component_id
```

**Voorbeeldrespons**

```json
{
  "id": "ckf01fvnxywz50a35nh1qzssm",
  "name": "Website",
  "description": "",
  "status": "OPERATIONAL",
  "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com",
  "showUptime": true,
  "order": 0,
  "group": null
}
```

## Een component aanmaken

**Endpoint:**

```bash
POST /v1/:page_id/components
```

**Voorbeeldverzoek:**

```json
{
  "name": "Test component",
  "description": "Testing",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false,
  "archived": false,
  "translations": {
    "name": {
      "fr": "Composant de test"
    },
    "description": {
      "fr": "En test"
    }
  }
}
```

**Voorbeeldrespons:**

```json
{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component",
  "description": "Testing",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "showUptime": true,
  "order": 8,
  "group": null,
  "translations": {
    "name": {
      "fr": "Composant de test"
    },
    "description": {
      "fr": "En test"
    }
  }
}
```

Wil je een component onder een groep plaatsen, zet dan `grouped` op `true` en `group` op de `ID` van de gewenste groep.

## Een component bijwerken

**Endpoint:**

```bash
PUT /v2/:page_id/components/:component_id
```

**Voorbeeldverzoek:**

```json
{
  "name": "Test component 4",
  "description": "Test test test",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false,
  "archived": true,
  "translations": {
    "name": {
      "fr": "Composant de test 4"
    },
    "description": {
      "fr": "Test test test"
    }
  }
}
```

**Voorbeeldrespons:**

```json
{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component 4",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "description": "Test test test",
  "showUptime": true,
  "order": 6,
  "group": null,
  "translations": {
    "name": {
      "fr": "Composant de test 4"
    },
    "description": {
      "fr": "Test test test"
    }
  }
}
```
Wil je de groep van een component wijzigen, zet dan `grouped` op `true` en `groupId` op de `ID` van de gewenste groep.

## Een component verwijderen

**Endpoint:**

```bash
DELETE /v1/:page_id/components/:component_id
```

```json
{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm"
}
```