HAhashtopolis
Agents

List Agents

Changed on

GET many request to retrieve multiple objects.

get/api/v2/ui/agents

Request

Query parameters

page[after]string

Pointer to paginate to retrieve the data after the object provided. Specify the base64 encoded JSON string in a uniquely identifiable manner (e.g. object IDs), i.e. by using one (primary) or two (primary and secondary) fields that allow for stable sorting.

Format: {"primary":{"someField": 123},"secondary":{"someOtherOptionalField": "Foo"}}

Example: {"primary":{"agentId": 123}} -> eyJwcmltYXJ5Ijp7ImFnZW50SWQiOiAxMjN9fQ==

page[before]string

Pointer to paginate to retrieve the data before the object provided. Specify the base64 encoded JSON string in a uniquely identifiable manner (e.g. object IDs), i.e. by using one (primary) or two (primary and secondary) fields that allow for stable sorting.

Format: {"primary":{"someField": 123},"secondary":{"someOtherOptionalField": "Foo"}}

Example: {"primary":{"agentId": 123}} -> eyJwcmltYXJ5Ijp7ImFnZW50SWQiOiAxMjN9fQ==

page[size]integer

Amount of data to retrieve inside a single page

filterobject

Filters results using a query. Every key is an attribute name optionally suffixed with a comparison operator, e.g. filter[agentId__gt]=200.

includestring[]

Relationships to include in the response, comma seperated. Possible options: user, accessGroups, agentStats, agentErrors, chunks, tasks, assignments

aggregateobject

Aggregated fields to include by type (comma separated values). Possible options: agent: crackingTime

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

  • 87f3bd43387fRevision changes
    • breaking

      added the pattern ^[A-Za-z0-9+/]*={0,2}$ to the query request parameter page[after]

    • breaking

      added the pattern ^[A-Za-z0-9+/]*={0,2}$ to the query request parameter page[before]

    • warning

      for the query request parameter page[size], the min was set to 1.00

    • info

      for the query request parameter page[after], the format was generalized from byte to no format

    • info

      for the query request parameter page[before], the format was generalized from byte to no format

  • 7f07b4fb3281Revision 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