Skip to main content
GET
/
components
/
{component}
Get Component
curl --request GET \
  --url http://localhost/api/components/{component}
{
  "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>"
          }
        ]
      }
    }
  }
}

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.

Path Parameters

​
component
integer
required

The component ID

Query Parameters

​
include
string

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

Response

Component

​
data
Component · object
required