Create Client - SpecterOps

POST

api

clients

{
  "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:

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

Required range: x > 0

Body

application/json

The request body for creating a client

name

string

domain_controller

string

type

enum<string>

This enum describes the collector client type.

Available options:

sharphound,

azurehound

events

object[]

Response

200

application/json

data

object

data.id

string

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

data.name

string

data.ip_address

string

data.hostname

string

data.configured_user

string

data.last_checkin

string

data.events

object[]

data.token

object

data.current_job_id

object

data.current_job

object

data.current_job.id

integer

This is the unique identifier for this object.

data.current_job.created_at

string

data.current_job.updated_at

string

data.current_job.deleted_at

object

data.current_job.client_id

string

data.current_job.client_name

string

data.current_job.event_id

object

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

data.current_job.end_time

string

data.current_job.log_path

object

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

data.current_job.event_title

string

data.current_job.last_ingest

string

data.current_job.ous

string[]

data.current_job.domains

string[]

data.current_job.domain_results

object[]

data.completed_job_count

integer

data.domain_controller

object

data.version

string

data.user_sid

object

data.type

enum<string>

This enum describes the collector client type.

Available options:

sharphound,

azurehound

List Clients Client Error

{
  "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"
  }
}

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

Body

Response