Tasks

PATCH request to update attributes of a single object.

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

Request

Path parameters

idinteger required

Request body

Response

successful operation

Example response

{
  "data": {
    "id": 1,
    "relationships": {
      "assignedAgents": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "crackerBinary": {
        "data": {
          "id": 1
        }
      },
      "crackerBinaryType": {
        "data": {
          "id": 1
        }
      },
      "files": {
        "data": [
          {
            "id": 1
          }
        ]
      },
      "hashlist": {
        "data": {
          "id": 1
        }
      },
      "speeds": {
        "data": [
          {
            "id": 1
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": 1
    }
  ]
}

Changes

    • breaking

      the response property //// became nullable for the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the new optional request property //