Clients
Enterprise

List Clients

Changed on

Lists available clients for processing collection events.

get/api/v2/clients

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/clients
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

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

  • b6add300f59fRevision changes
    • info

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

  • e59754bccd6eRevision changes
    • warning

      removed the optional property //// from the response with the status