Skip to main content
PUT
/
components
/
{component}
Update Component
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
}
'
{
  "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>"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
component
integer
required

The component ID

Body

application/json

UpdateComponentRequestData

​
name
string | null
Maximum string length: 255
​
description
string | null
​
status
enum<integer> | null
Available options:
1,
2,
3,
4,
5,
6
​
link
string | null
​
order
integer | null
Required range: x >= 0
​
enabled
boolean
default:true
​
component_group_id
integer | null
Required range: x >= 0

Response

Component

​
data
Component · object
required