API Documentation
Components
Component Groups
Incident Updates
Incident Templates
Components
Update Component
PUT
/
components
/
{component}
Copy
Ask AI
curl --request PUT \
--url http://localhost/api/components/{component} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>",
"status": 1,
"link": "<string>",
"order": 1,
"enabled": true,
"component_group_id": 1
}'
Copy
Ask AI
{
"data": {
"id": "<string>",
"type": "components",
"attributes": {
"id": 123,
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": 123,
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": true,
"meta": [
"<any>"
],
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {
"type": "componentGroups",
"id": "<string>"
}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": 123,
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": 123,
"visible": 0,
"stickied": true,
"notifications": 123,
"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": 123,
"updateable_id": 123,
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
}
]
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The component ID
Body
application/json
UpdateComponentRequestData
The body is of type object
.
Response
200
application/json
Component
The response is of type object
.
Copy
Ask AI
curl --request PUT \
--url http://localhost/api/components/{component} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>",
"status": 1,
"link": "<string>",
"order": 1,
"enabled": true,
"component_group_id": 1
}'
Copy
Ask AI
{
"data": {
"id": "<string>",
"type": "components",
"attributes": {
"id": 123,
"name": "<string>",
"description": "<string>",
"link": "<string>",
"order": 123,
"status": {
"human": "<string>",
"value": "<string>"
},
"enabled": true,
"meta": [
"<any>"
],
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
},
"relationships": {
"group": {
"data": {
"type": "componentGroups",
"id": "<string>"
}
},
"incidents": {
"data": [
{
"id": "<string>",
"type": "incidents",
"attributes": {
"id": 123,
"guid": "<string>",
"name": "<string>",
"message": "<string>",
"component_id": 123,
"visible": 0,
"stickied": true,
"notifications": 123,
"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": 123,
"updateable_id": 123,
"updateable_type": "<string>",
"message": "<string>",
"status": {
"human": "<string>",
"value": "<string>"
},
"created": {
"human": "<string>",
"string": "<string>"
},
"updated": {
"human": "<string>",
"string": "<string>"
}
}
}
]
},
"user": {
"data": {
"type": "<string>",
"id": "<string>"
}
}
}
}
]
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.