コンテンツにスキップ
Yagra

export_bundle

GET
/api/v1/config/bundle
curl --request GET \
  --url https://example.com/api/v1/config/bundle \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The deployment’s monitoring configuration as a portable bundle. Carries no secrets — credentials, channel configs and ingest tokens stay in this deployment

Media typeapplication/json

A whole configuration bundle.

object
analysis_schedules
Array<object>

A recurring Troubleshoot analysis.

object
at_hour
required
integer format: int32
at_minute
required
integer format: int32
day_of_month
integer | null format: int32
day_of_week
integer | null format: int32
enabled
required
boolean
frequency
required
string
id
required
string format: uuid
params
required
scope_id
string | null format: uuid
scope_kind
required
string
scope_label
required
string
tool
required
string
app_settings
One of:
null
classification_rules
Array<object>

A discovery classification rule.

object
enabled
required
boolean
id
required
string format: uuid
model
string | null
priority
required
integer format: int32
profile_id
required
string format: uuid
sysdescr_regex
string | null
sysobjectid_prefix
string | null
vendor
string | null
collection_template_items
Array<object>

One metric inside a collection template.

object
collection
required
string
enabled
required
boolean
id
required
string format: uuid
metric_kind
required
string
metric_name
required
string
oid
required
string
template_id
required
string format: uuid
collection_templates
Array<object>

A reusable collection template.

object
description
string | null
id
required
string format: uuid
name
required
string
dns_checks
Array<object>

A DNS monitor’s configuration (1:1 with its node).

object
max_depth
required
integer format: int32
name
required
string
node_id
required
string format: uuid
record_type
required
string
resolver_ip
string | null
resolver_port
required
integer format: int32
timeout_ms
required
integer format: int32
event_rules
Array<object>

A passive-event match rule.

object
clear_pattern
string | null
enabled
required
boolean
id
required
string format: uuid
match_kind
required
string
min_count
required
integer format: int32
name
required
string
node_id
string | null format: uuid
pattern
required
string
severity
required
string
source_id
string | null format: uuid
source_kind
string | null
ttl_secs
required
integer format: int32
window_secs
required
integer format: int32
event_sources
Array<object>

A passive-event ingest source.

object
enabled
required
boolean
id
required
string format: uuid
kind
required
string
name
required
string
node_id
string | null format: uuid
exported_at
required

When the export ran.

string format: date-time
format
required

Always yagra.config-bundle. An importer refuses anything else rather than guessing.

string
forward_destinations
Array<object>

A forwarding destination. Its optional sealed secret is not carried; a destination that had one arrives disabled.

object
ca_cert
string | null
dest_kind
required
string
enabled
required
boolean
filter
required
had_secret

Whether the source deployment had a sealed secret on this destination. Carries no secret — it is what tells the importer to arrive disabled and what tells the operator to re-enter it.

boolean
id
required
string format: uuid
name
required
string
pool
string | null
rate_limit_per_sec
integer | null format: int32
source_kind
required
string
target
required
string
verbatim
required
boolean
node_groups
Array<object>

A folder in the inventory tree.

object
group_type
required
string
id
required
string format: uuid
latitude
number | null format: double
longitude
number | null format: double
name
required
string
parent_id
string | null format: uuid
pool
string | null
sort_order
required
number format: double
nodes
Array<object>

A monitored node. credential_id is a reference only — see the module docs.

object
address
required

IPv4 or IPv6, as text.

string
credential_id
string | null format: uuid
group_id
string | null format: uuid
id
required
string format: uuid
model
string | null
name
required
string
parent_id
string | null format: uuid
pool
string | null
profile_id
string | null format: uuid
sort_order
required
number format: double
tags
required
vendor
string | null
notes

What the export left out or changed. Informational; ignored on import.

Array<object>

One note, with the table it concerns and how many rows it covers.

object
code
required

What happened.

string
Allowed values: skipped_builtin skipped_missing_reference reference_dropped secret_dropped_imported_disabled webhook_token_reset schedule_next_run_recomputed
count
required

How many rows this note covers.

integer format: int32
field

The column involved, when the note is about one (e.g. credential_id).

string | null
table
required

The table the note is about.

string
profile_collection_templates
Array<object>

A profile↔template attachment.

object
profile_id
required
string format: uuid
template_id
required
string format: uuid
profiles
Array<object>

A device profile.

object
category
required
string
id
required
string format: uuid
name
required
string
parent_id
string | null format: uuid
poll_interval_secs
integer | null format: int32
vendor
string | null
report_definitions
Array<object>

A saved report template.

object
description
string | null
id
required
string format: uuid
name
required
string
spec
required
report_schedules
Array<object>

A recurring report run.

object
at_hour
required
integer format: int32
at_minute
required
integer format: int32
day_of_month
integer | null format: int32
day_of_week
integer | null format: int32
definition_id
required
string format: uuid
enabled
required
boolean
frequency
required
string
id
required
string format: uuid
secrets

How secrets are represented. Always references — a bundle never carries one.

string
Allowed values: references
thresholds
Array<object>

A threshold rule.

object
critical
number | null format: double
direction
required
string
dwell_samples
required
integer format: int32
id
required
string format: uuid
metric
required
string
scope_id
required
string
scope_level
required
string
warning
number | null format: double
url_checks
Array<object>

A URL / HTTP endpoint monitor’s configuration (1:1 with its node).

object
body_match

The monitor’s response-body keyword rule, if it has one.

body_max_bytes

How many bytes of the response body the monitor reads.

integer format: int32
credential_id
string | null format: uuid
expected_status
required
follow_redirects
required
boolean
json_extract

The monitor’s JSON extraction rules, if it has any.

method
required
string
node_id
required
string format: uuid
timeout_ms
required
integer format: int32
url
required
string
verify_tls
required
boolean
version
required

Bundle schema version.

integer format: int32
yagra_version
required

The Yagra version that produced it.

string
Example
{
  "notes": [
    {
      "code": "skipped_builtin"
    }
  ],
  "secrets": "references"
}

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks ManageConfig

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

413

Section titled “413”

A table holds more rows than one bundle carries; use a database dump for a deployment this size

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “503”

Inventory storage is unavailable (skeleton mode)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}