Update Client - SpecterOps

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": {
      "time": "2023-11-07T05:31:56Z",
      "valid": true
    },
    "name": "<string>",
    "ip_address": "127.0.0.1",
    "hostname": "<string>",
    "configured_user": "<string>",
    "last_checkin": "2023-11-07T05:31:56Z",
    "events": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": {
          "time": "2023-11-07T05:31:56Z",
          "valid": true
        },
        "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rrule": "<string>",
        "session_collection": true,
        "local_group_collection": true,
        "ad_structure_collection": true,
        "cert_services_collection": true,
        "ca_registry_collection": true,
        "dc_registry_collection": true,
        "all_trusted_domains": true,
        "next_scheduled_at": "2023-11-07T05:31:56Z",
        "ous": [
          "<string>"
        ],
        "domains": [
          "<string>"
        ]
      }
    ],
    "token": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "user_id": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valid": true
      },
      "name": {
        "string": "<string>",
        "valid": true
      },
      "key": "<string>",
      "hmac_method": "<string>",
      "last_access": "2023-11-07T05:31:56Z"
    },
    "current_job_id": {
      "int64": 123,
      "valid": true
    },
    "current_job": {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "client_name": "<string>",
      "event_id": {
        "int32": 123,
        "valid": true
      },
      "status": -1,
      "statusMessage": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "log_path": {
        "string": "<string>",
        "valid": true
      },
      "session_collection": true,
      "local_group_collection": true,
      "ad_structure_collection": true,
      "cert_services_collection": true,
      "ca_registry_collection": true,
      "dc_registry_collection": true,
      "all_trusted_domains": true,
      "domain_controller": {
        "string": "<string>",
        "valid": true
      },
      "event_title": "<string>",
      "last_ingest": "2023-11-07T05:31:56Z",
      "ous": [
        "<string>"
      ],
      "domains": [
        "<string>"
      ],
      "domain_results": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": {
            "time": "2023-11-07T05:31:56Z",
            "valid": true
          },
          "job_id": 123,
          "domain_name": "<string>",
          "success": true,
          "message": "<string>",
          "user_count": 123,
          "group_count": 123,
          "computer_count": 123,
          "gpo_count": 123,
          "ou_count": 123,
          "container_count": 123,
          "aiaca_count": 123,
          "rootca_count": 123,
          "enterpriseca_count": 123,
          "ntauthstore_count": 123,
          "certtemplate_count": 123,
          "deleted_count": 123
        }
      ]
    },
    "completed_job_count": 123,
    "domain_controller": {
      "string": "<string>",
      "valid": true
    },
    "version": "<string>",
    "user_sid": {
      "string": "<string>",
      "valid": true
    },
    "type": "sharphound"
  }
}

PUT

api

clients

{client_id}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": {
      "time": "2023-11-07T05:31:56Z",
      "valid": true
    },
    "name": "<string>",
    "ip_address": "127.0.0.1",
    "hostname": "<string>",
    "configured_user": "<string>",
    "last_checkin": "2023-11-07T05:31:56Z",
    "events": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": {
          "time": "2023-11-07T05:31:56Z",
          "valid": true
        },
        "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rrule": "<string>",
        "session_collection": true,
        "local_group_collection": true,
        "ad_structure_collection": true,
        "cert_services_collection": true,
        "ca_registry_collection": true,
        "dc_registry_collection": true,
        "all_trusted_domains": true,
        "next_scheduled_at": "2023-11-07T05:31:56Z",
        "ous": [
          "<string>"
        ],
        "domains": [
          "<string>"
        ]
      }
    ],
    "token": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "user_id": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "valid": true
      },
      "name": {
        "string": "<string>",
        "valid": true
      },
      "key": "<string>",
      "hmac_method": "<string>",
      "last_access": "2023-11-07T05:31:56Z"
    },
    "current_job_id": {
      "int64": 123,
      "valid": true
    },
    "current_job": {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "client_name": "<string>",
      "event_id": {
        "int32": 123,
        "valid": true
      },
      "status": -1,
      "statusMessage": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "log_path": {
        "string": "<string>",
        "valid": true
      },
      "session_collection": true,
      "local_group_collection": true,
      "ad_structure_collection": true,
      "cert_services_collection": true,
      "ca_registry_collection": true,
      "dc_registry_collection": true,
      "all_trusted_domains": true,
      "domain_controller": {
        "string": "<string>",
        "valid": true
      },
      "event_title": "<string>",
      "last_ingest": "2023-11-07T05:31:56Z",
      "ous": [
        "<string>"
      ],
      "domains": [
        "<string>"
      ],
      "domain_results": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": {
            "time": "2023-11-07T05:31:56Z",
            "valid": true
          },
          "job_id": 123,
          "domain_name": "<string>",
          "success": true,
          "message": "<string>",
          "user_count": 123,
          "group_count": 123,
          "computer_count": 123,
          "gpo_count": 123,
          "ou_count": 123,
          "container_count": 123,
          "aiaca_count": 123,
          "rootca_count": 123,
          "enterpriseca_count": 123,
          "ntauthstore_count": 123,
          "certtemplate_count": 123,
          "deleted_count": 123
        }
      ]
    },
    "completed_job_count": 123,
    "domain_controller": {
      "string": "<string>",
      "valid": true
    },
    "version": "<string>",
    "user_sid": {
      "string": "<string>",
      "valid": true
    },
    "type": "sharphound"
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Path Parameters

client_id

string<uuid>

required

Client ID

Body

application/json

The request body for updating a client

name

string

domain_controller

string

Response

data

object

Show child attributes

data.id

string<uuid>

This is the unique identifier for this object.

data.created_at

string<date-time>

data.updated_at

string<date-time>

data.deleted_at

object

Show child attributes

data.deleted_at.time

string<date-time>

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.name

string

data.ip_address

string<ipv4>

data.hostname

string<hostname>

data.configured_user

string

data.last_checkin

string<date-time>

data.events

object[]

Show child attributes

data.events.id

integer<int32>

This is the unique identifier for this object.

data.events.created_at

string<date-time>

data.events.updated_at

string<date-time>

data.events.deleted_at

object

Show child attributes

data.events.deleted_at.time

string<date-time>

An RFC-3339 formatted string

data.events.deleted_at.valid

boolean

Valid is true if time is not null.

data.events.client_id

string<uuid>

data.events.rrule

string

data.events.session_collection

boolean

data.events.local_group_collection

boolean

data.events.ad_structure_collection

boolean

data.events.cert_services_collection

boolean

data.events.ca_registry_collection

boolean

data.events.dc_registry_collection

boolean

data.events.all_trusted_domains

boolean

data.events.next_scheduled_at

string<date-time>

data.events.ous

string[]

data.events.domains

string[]

data.token

object

Show child attributes

data.token.id

string<uuid>

This is the unique identifier for this object.

data.token.created_at

string<date-time>

data.token.updated_at

string<date-time>

data.token.deleted_at

object

Show child attributes

data.token.deleted_at.time

string<date-time>

An RFC-3339 formatted string

data.token.deleted_at.valid

boolean

Valid is true if time is not null.

data.token.user_id

object

Show child attributes

data.token.user_id.uuid

string<uuid>

data.token.user_id.valid

boolean

Valid is true if uuid is not null.

data.token.name

object

Show child attributes

data.token.name.string

string

data.token.name.valid

boolean

Valid is true if string is not null

data.token.key

string

data.token.hmac_method

string

data.token.last_access

string<date-time>

data.current_job_id

object

Show child attributes

data.current_job_id.int64

integer<int64>

data.current_job_id.valid

boolean

Valid is true if int64 is not null.

data.current_job

object

Show child attributes

data.current_job.id

integer<int64>

This is the unique identifier for this object.

data.current_job.created_at

string<date-time>

data.current_job.updated_at

string<date-time>

data.current_job.deleted_at

object

Show child attributes

data.current_job.deleted_at.time

string<date-time>

An RFC-3339 formatted string

data.current_job.deleted_at.valid

boolean

Valid is true if time is not null.

data.current_job.client_id

string<uuid>

data.current_job.client_name

string

data.current_job.event_id

object

Show child attributes

data.current_job.event_id.int32

integer<int32>

data.current_job.event_id.valid

boolean

Valid is true if int32 is not null.

data.current_job.status

enum<integer>

This enum describes the current status of a Job. Values are:

-1 Invalid
0 Ready
1 Running
2 Complete
3 Canceled
4 Timed Out
5 Failed
6 Ingesting
7 Analyzing
8 Partially Complete

Available options:

-1,

0,

1,

2,

3,

4,

5,

6,

7,

8

data.current_job.statusMessage

string

data.current_job.start_time

string<date-time>

data.current_job.end_time

string<date-time>

data.current_job.log_path

object

Show child attributes

data.current_job.log_path.string

string

data.current_job.log_path.valid

boolean

Valid is true if string is not null

data.current_job.session_collection

boolean

data.current_job.local_group_collection

boolean

data.current_job.ad_structure_collection

boolean

data.current_job.cert_services_collection

boolean

data.current_job.ca_registry_collection

boolean

data.current_job.dc_registry_collection

boolean

data.current_job.all_trusted_domains

boolean

data.current_job.domain_controller

object

Show child attributes

data.current_job.domain_controller.string

string

data.current_job.domain_controller.valid

boolean

Valid is true if string is not null

data.current_job.event_title

string

data.current_job.last_ingest

string<date-time>

data.current_job.ous

string[]

data.current_job.domains

string[]

data.current_job.domain_results

object[]

Show child attributes

data.current_job.domain_results.id

integer<int64>

This is the unique identifier for this object.

data.current_job.domain_results.created_at

string<date-time>

data.current_job.domain_results.updated_at

string<date-time>

data.current_job.domain_results.deleted_at

object

Show child attributes

data.current_job.domain_results.deleted_at.time

string<date-time>

An RFC-3339 formatted string

data.current_job.domain_results.deleted_at.valid

boolean

Valid is true if time is not null.

data.current_job.domain_results.job_id

integer<int64>

data.current_job.domain_results.domain_name

string

Name of the domain that was enumerated

data.current_job.domain_results.success

boolean

A boolean value indicating whether the domain enumeration succeeded

data.current_job.domain_results.message

string

A status message for a domain enumeration result

data.current_job.domain_results.user_count

integer

A count of users enumerated

data.current_job.domain_results.group_count

integer

A count of groups enumerated

data.current_job.domain_results.computer_count

integer

A count of computers enumerated

data.current_job.domain_results.gpo_count

integer

A count of gpos enumerated

data.current_job.domain_results.ou_count

integer

A count of ous enumerated

data.current_job.domain_results.container_count

integer

A count of containers enumerated

data.current_job.domain_results.aiaca_count

integer

A count of aiacas enumerated

data.current_job.domain_results.rootca_count

integer

A count of rootcas enumerated

data.current_job.domain_results.enterpriseca_count

integer

A count of enterprisecas enumerated

data.current_job.domain_results.ntauthstore_count

integer

A count of ntauthstores enumerated

data.current_job.domain_results.certtemplate_count

integer

A count of certtemplates enumerated

data.current_job.domain_results.deleted_count

integer

A count of deleted objects enumerated

data.completed_job_count

integer<int32>

data.domain_controller

object

Show child attributes

data.domain_controller.string

string

data.domain_controller.valid

boolean

Valid is true if string is not null

data.version

string

data.user_sid

object

Show child attributes

data.user_sid.string

string

data.user_sid.valid

boolean

Valid is true if string is not null

data.type

enum<string>

This enum describes the collector client type.

Available options:

sharphound,

azurehound

Get Client Delete Client

⌘I

Get Started

Auth

Permissions

Roles

API Tokens

BloodHound Users

Collectors

Collection Uploads

API Info

Search

Audit

Config

Asset Isolation

Graph

Cypher

Azure Entities

AD Base Entities

Computers

Containers

Domains

GPOs

AIA CAs

Root CAs

Enterprise CAs

NT Auth Stores

Cert Templates

OUs

AD Users

Groups

Data Quality

Database

Datapipe

EULA

Analysis

Client Ingest

Clients

Jobs

Events (Schedules)

Attack Paths

Risk Posture

Meta Entities

Authorizations

Headers

Path Parameters

Body

Response