Sign in
Clients
Enterprise

List Clients

Lists available clients for processing collection events.

get/api/v2/clients

Query parameters

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by deleted_at value. See filter schema details for valid predicates.

hydrate_domainsboolean

When a value of true is passed, any Domains associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same Domains will only return as a list of objectids.

hydrate_ousboolean

When a value of true is passed, any OUs associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same OUs will only return as a list of objectids.

skipinteger

The number of items to skip in a paginated response.

This query parameter is used for determining the number of objects to skip in pagination.

limitinteger

The limit of results requested by the client.

This query parameter is used for setting an upper limit of objects returned in paginated responses.

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are name, ip_address, hostname, configured_user, last_checkin, completed_job_count, created_at, updated_at, deleted_at.

namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

ip_addressstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

hostnamestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

configured_userstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

versionstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

user_sidstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

last_checkinstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

current_job_idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

completed_job_countstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

domain_controllerstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

idstring

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

Response

OK

countinteger

The total number of results.

skipinteger

The number of items to skip in a paginated response.

limitinteger

The limit of results requested by the client.

Changes

Changed in 17 of the 66 revisions of this API.45658

  • e59754bccd6e1See the full diff
    • ●

      removed the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary from the response with the 200 status

      response-optional-property-removed

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7671374e96b64See the full diff
    • ○

      added model.client-support-bundle to the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added model.client-support-bundle to the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed model.client-management-operation from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed model.client-management-operation from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished response property allOf list for the response status 200

      response-property-all-of-removed

  • 6ba85920fb53810See the full diff
    • ▲

      the response property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id response's property type/format changed from / to string/uuid for status 200

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id response's property type/format changed from / to string/uuid for status 200

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id response's property type/format changed from / to string/uuid for status 200

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id response's property type/format changed from / to string/uuid for status 200

      response-property-type-changed

    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      removed null.uuid from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed null.uuid from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/current/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed null.uuid from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/artifact_id response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed null.uuid from the allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary/last_finished/allOf[model.client-management-operation]/allOf[subschema #2]/requested_by_user_id response property allOf list for the response status 200

      response-property-all-of-removed

  • 02198b453e511See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary to the response with the 200 status

      response-optional-property-added

  • 367a21c392bc1See the full diff
    • ●

      removed the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 25477a7cf18a1See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary to the response with the 200 status

      response-optional-property-added

  • 37505efd27011See the full diff
    • ●

      removed the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary from the response with the 200 status

      response-optional-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b7d6f0054ef21See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/support_bundle_summary to the response with the 200 status

      response-optional-property-added

  • a5318c3cf1e31See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/items/allOf[subschema #2]/token/allOf[subschema #3]/created_by to the response with the 200 status

      response-optional-property-added

  • f87a90d5a2d011See the full diff
    • ▲

      added the pattern ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ to the query request parameter id

      request-parameter-pattern-added

    • ○

      for the query request parameter id, the type/format was generalized from string/uuid to string/

      request-parameter-type-generalized