Skip to main content
GET
/
components
List Components
curl --request GET \
  --url http://localhost/api/components
{
  "data": [
    {
      "id": "<string>",
      "type": "components",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "link": "<string>",
        "order": 123,
        "status": {
          "human": "<string>",
          "value": "<string>"
        },
        "enabled": true,
        "meta": [
          "<unknown>"
        ],
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        },
        "pivot": {
          "component_status": {
            "human": "<string>",
            "value": "<string>"
          }
        }
      },
      "relationships": {
        "group": {
          "data": {
            "type": "componentGroups",
            "id": "<string>"
          }
        },
        "incidents": {
          "data": [
            {
              "type": "incidents",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123
  },
  "included": [
    {
      "id": "<string>",
      "type": "componentGroups",
      "attributes": {
        "id": 123,
        "name": "<string>",
        "order": 123,
        "visible": 0,
        "created": {
          "human": "<string>",
          "string": "<string>"
        },
        "updated": {
          "human": "<string>",
          "string": "<string>"
        }
      },
      "relationships": {
        "components": {
          "data": [
            {
              "type": "components",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cachethq.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

per_page
integer
default:15

How many items to show per page.

page
integer

Which page to show.

filter[status]
enum<integer>

Filter by status

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

Filter by name.

filter[enabled]
boolean

Filter by enabled status.

Response

200 - application/vnd.api+json

Paginated set of Component

data
Component · object[]
required
meta
object
required
included
(ComponentGroup · object | Incident · object)[]