targets

add_site_direct: upload Target struct

Body Fields

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/add-direct -d '{
  "bbox": "0",
  "name": "test0",
  "tags": [
    "test"
  ]
}'

add_site: upload target YAML definition

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/add --data-binary 'name: "test0"
bbox: "0"
'

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/add

update_site: upload site definition which will be merged with site using this id

Body Fields

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/update -d '{
  "bbox": "0",
  "name": "test_zero"
}'

update_site_yaml: like update_site, except provide Target in YAML

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/update/update-yaml --data-binary 'bbox: "0"
name: test_zero
'

get_sites: get all sites, optionally filtering by tags, tenant, names or target ids

Body Fields

Examples

search by target id

cURL

curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/list -d '{
  "targets": [
    "0"
  ]
}'

Output

{
  "Sites": [
  {
    "name": "test0",
    "bbox": "0",
    "tenant": "default",
    "trace": [],
    "pipelines": [],
    "tags": [
        "test"
    ],
    "context": {},
    "protected": false
  }
  ]
}

search by matching tags

cURL

curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/list -d '{
  "tags": [
    "test"
  ]
}'

get_target_ids: get all site ids, filtering by tags, tenants or names

Body Fields

add_all_sites: upload full 'sites.yml' definition

remove_site: remove site by id

Params

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/remove/0

add_pipeline_to_site: add a pipeline by name to a site by id

Body Fields

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/add-pipe -d '{
  "pipe": "simple",
  "target_id": "0"
}'

remove_pipeline_from_site: remove pipe from target

Body Fields

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/remove-pipe -d '{
  "target_id": "0",
  "value": "simple"
}'

remove_tag_from_site: remove tag from target

Body Fields

add_tag_to_site: add a tag to a target

Body Fields

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/add-tag -d '{
  "target_id": "0",
  "value": "tagged"
}'

rebuild_targets: rebuild specified targets by name

Examples

cURL

curl -X POST -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/rebuild -d '[
  "0"
]'

start_target_update: indicate that a set of target updates will happen

end_target_update: target updates are finished and building can happen

get_target_report_times: get the agent report times in epoch secs

get_target_pipe_statuses: return status map for particular target, or all if target is '*'

Params

set_target_settings: set log settings etc for a set of targets

get_target_settings: get current settings for this target

Params

Examples

get all the settings for target ID '0'

cURL

curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/get-settings/0

get_metrics: get metrics from the Hotrodd

Body Fields

get_logs: get remote logs from the Hotrodd server

Body Fields

Examples

cURL

curl -X GET -H 'Content-Type: application/json' -H "Authorization: $JWT" \
$URL/api/v1/targets/logs -d '{
  "num_records": 1,
  "pipes": [
    "HRD"
  ],
  "targets": [
    "SERVER"
  ]
}'