PUT
/
components
/
{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": "<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>"
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

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

Response

200
application/json
`Component`
​
data
object
required
Get ComponentDelete Component