Endpoint for clients to update their own information at startup.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
{
"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"
}
}
Authorization: Bearer $JWT_TOKEN
Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.
x >= 0
The request body for updating a client
The body is of type object
.
OK
The response is of type object
.
{
"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"
}
}
Endpoint for clients to update their own information at startup.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
{
"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"
}
}
Authorization: Bearer $JWT_TOKEN
Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.
x >= 0
The request body for updating a client
The body is of type object
.
OK
The response is of type object
.
{
"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"
}
}