GET
/
components
curl --request GET \
  --url http://localhost/api/components
{
  "data": [
    {
      "id": "<string>",
      "type": "components",
      "attributes": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "link": "<string>",
        "order": "<string>",
        "status": {
          "human": "<string>",
          "value": "<string>"
        },
        "enabled": "<string>",
        "meta": "<string>",
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        }
      },
      "relationships": {
        "group": {
          "data": {
            "id": "<string>",
            "type": "componentGroups",
            "attributes": {
              "id": "<string>",
              "name": "<string>",
              "order": "<string>",
              "visible": "<string>",
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            },
            "relationships": {
              "components": {
                "data": [
                  {}
                ]
              }
            }
          }
        },
        "incidents": {
          "data": [
            {
              "id": "<string>",
              "type": "incidents",
              "attributes": {
                "id": "<string>",
                "guid": "<string>",
                "name": "<string>",
                "message": "<string>",
                "component_id": "<string>",
                "visible": "<string>",
                "stickied": "<string>",
                "notifications": "<string>",
                "status": {
                  "human": "<string>",
                  "value": "<string>"
                },
                "occurred": {
                  "human": "<string>",
                  "string": "<string>"
                },
                "created": {
                  "human": "<string>",
                  "string": "<string>"
                },
                "updated": {
                  "human": "<string>",
                  "string": "<string>"
                }
              },
              "relationships": {
                "components": {
                  "data": [
                    {}
                  ]
                },
                "updates": {
                  "data": [
                    {
                      "id": "<string>",
                      "type": "updates",
                      "attributes": {
                        "id": "<string>",
                        "updateable_id": "<string>",
                        "updateable_type": "<string>",
                        "message": "<string>",
                        "status": {
                          "human": "<string>",
                          "value": "<string>"
                        },
                        "created": {
                          "human": "<string>",
                          "string": "<string>"
                        },
                        "updated": {
                          "human": "<string>",
                          "string": "<string>"
                        }
                      }
                    }
                  ]
                },
                "user": {
                  "data": {
                    "id": "<string>",
                    "type": "<string>",
                    "attributes": {
                      "id": "<string>"
                    }
                  }
                }
              }
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "from": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  }
}

Query Parameters

​
sort
string

Available sorts are name, order, id. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -name.

​
include
string

Available includes are group, groupCount, groupExists, incidents, incidentsCount, incidentsExists. You can include multiple options by separating them with a comma.

​
filter[status]
enum<integer>

Filter by status

Available options:
1,
2,
3,
4,
5
​
filter[name]
string

Filter by name.

​
filter[enabled]
boolean

Filter by enabled status.

​
per_page
integer
default:
15

How many items to show per page.

​
page
integer

Which page to show.

Response

200 - application/json
Paginated set of `Component`
​
data
object[]
required
​
meta
object
required
​
links
object
required
Get System StatusCreate Component