# 구성 요소 API 레퍼런스

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

## 상태 페이지의 모든 구성 요소 가져오기

**엔드포인트:**

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

- 기본 page 번호는 1입니다.
- 기본 per_page 값은 50이며 페이지당 최대 100개입니다.

**응답 예시:**

```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"
  }
]
```

## 구성 요소 가져오기

**엔드포인트:**

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

**응답 예시**

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

## 구성 요소 만들기

**엔드포인트:**

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

**요청 예시:**

```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"
    }
  }
}
```

**응답 예시:**

```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"
    }
  }
}
```

구성 요소를 그룹에 넣으려면 `grouped`를 `true`로, `group`을 원하는 그룹의 `ID`로 설정하세요.

## 구성 요소 업데이트하기

**엔드포인트:**

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

**요청 예시:**

```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"
    }
  }
}
```

**응답 예시:**

```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"
    }
  }
}
```
구성 요소의 그룹을 변경하려면 `grouped`를 `true`로, `groupId`를 원하는 그룹의 `ID`로 설정하세요.

## 구성 요소 삭제하기

**엔드포인트:**

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

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