Agents

PATCH request to update attributes of a single object.

patch/api/v2/ui/agents/{id}

Request

Path parameters

idinteger required

Request body

Response

successful operation

Example response

{
  "data": {
    "id": 1,
    "relationships": {
      "accessGroups": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "agentErrors": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "agentStats": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "assignments": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "chunks": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "tasks": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "user": {
        "data": {
          "id": 1
        }
      }
    }
  },
  "included": [
    {
      "id": 1
    }
  ]
}

Changes

    • breaking

      added subschema #1 subschema #5 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #5 from the / response property oneOf list for the response status