@robinmordasiewicz/f5xc-api-mcp 2.0.13-2601051957 → 2.0.20-2601072244
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/dist/config/paths.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -1
- package/dist/tools/generated/ce_management/index.js +179 -1582
- package/dist/tools/generated/ce_management/index.js.map +1 -1
- package/dist/tools/generated/dependency-graph.json +2 -265
- package/dist/version.d.ts +2 -2
- package/dist/version.js +2 -2
- package/manifest.json +1 -1
- package/package.json +1 -1
- package/specs/domains/admin_console_and_ui.json +111 -25
- package/specs/domains/ai_services.json +114 -35
- package/specs/domains/api.json +1082 -177
- package/specs/domains/authentication.json +205 -45
- package/specs/domains/bigip.json +593 -101
- package/specs/domains/billing_and_usage.json +440 -82
- package/specs/domains/blindfold.json +713 -110
- package/specs/domains/bot_and_threat_defense.json +359 -65
- package/specs/domains/cdn.json +2131 -194
- package/specs/domains/ce_management.json +9110 -15844
- package/specs/domains/certificates.json +362 -75
- package/specs/domains/cloud_infrastructure.json +802 -119
- package/specs/domains/container_services.json +613 -95
- package/specs/domains/data_and_privacy_security.json +364 -66
- package/specs/domains/data_intelligence.json +324 -63
- package/specs/domains/ddos.json +766 -159
- package/specs/domains/dns.json +820 -161
- package/specs/domains/managed_kubernetes.json +455 -85
- package/specs/domains/marketplace.json +670 -104
- package/specs/domains/network.json +1620 -238
- package/specs/domains/network_security.json +1401 -191
- package/specs/domains/nginx_one.json +326 -62
- package/specs/domains/object_storage.json +49 -15
- package/specs/domains/observability.json +999 -147
- package/specs/domains/rate_limiting.json +300 -55
- package/specs/domains/secops_and_incident_response.json +189 -36
- package/specs/domains/service_mesh.json +955 -124
- package/specs/domains/shape.json +2150 -397
- package/specs/domains/sites.json +3830 -364
- package/specs/domains/statistics.json +2117 -235
- package/specs/domains/support.json +602 -108
- package/specs/domains/telemetry_and_insights.json +753 -79
- package/specs/domains/tenant_and_identity.json +1874 -308
- package/specs/domains/threat_campaign.json +637 -71
- package/specs/domains/users.json +278 -66
- package/specs/domains/virtual.json +2803 -260
- package/specs/domains/vpm_and_node_management.json +3 -1
- package/specs/domains/waf.json +1125 -148
- package/specs/index.json +24 -24
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Blindfold",
|
|
5
5
|
"description": "Public key retrieval and secret policy enforcement for encrypted data handling. Policy rules govern access with configurable matching and transformation actions. VoltShare integration provides decryption services, access counting, and audit log aggregation. Namespace-scoped policies enable fine-grained control over sensitive information with administrative overrides.",
|
|
6
|
-
"version": "2.0.
|
|
6
|
+
"version": "2.0.20",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "F5 Distributed Cloud",
|
|
9
9
|
"url": "https://docs.cloud.f5.com"
|
|
@@ -7306,6 +7306,7 @@
|
|
|
7306
7306
|
"ves.io.schema.rules.repeated.max_items": "64",
|
|
7307
7307
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7308
7308
|
},
|
|
7309
|
+
"x-f5xc-description-short": "List of exact values to match the input against.",
|
|
7309
7310
|
"x-f5xc-required-for": {
|
|
7310
7311
|
"minimum_config": false,
|
|
7311
7312
|
"create": false,
|
|
@@ -7339,6 +7340,7 @@
|
|
|
7339
7340
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
7340
7341
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7341
7342
|
},
|
|
7343
|
+
"x-f5xc-description-short": "List of regular expressions to match the input against.",
|
|
7342
7344
|
"x-f5xc-required-for": {
|
|
7343
7345
|
"minimum_config": false,
|
|
7344
7346
|
"create": false,
|
|
@@ -7364,6 +7366,7 @@
|
|
|
7364
7366
|
"ves.io.schema.rules.repeated.max_items": "9",
|
|
7365
7367
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
7366
7368
|
},
|
|
7369
|
+
"x-f5xc-description-short": "Ordered list of transformers (starting from index 0) to be applied to the path before matching.",
|
|
7367
7370
|
"x-f5xc-required-for": {
|
|
7368
7371
|
"minimum_config": false,
|
|
7369
7372
|
"create": false,
|
|
@@ -7372,6 +7375,8 @@
|
|
|
7372
7375
|
}
|
|
7373
7376
|
}
|
|
7374
7377
|
},
|
|
7378
|
+
"x-f5xc-description-short": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied.",
|
|
7379
|
+
"x-f5xc-description-medium": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions.",
|
|
7375
7380
|
"x-f5xc-minimum-configuration": {
|
|
7376
7381
|
"description": "Minimum configuration for policyMatcherType",
|
|
7377
7382
|
"required_fields": [
|
|
@@ -7398,6 +7403,8 @@
|
|
|
7398
7403
|
"default": "DENY",
|
|
7399
7404
|
"x-displayname": "Rule Action.",
|
|
7400
7405
|
"x-ves-proto-enum": "ves.io.schema.policy.RuleAction",
|
|
7406
|
+
"x-f5xc-description-short": "The rule action determines the disposition of the input request API.",
|
|
7407
|
+
"x-f5xc-description-medium": "The rule action determines the disposition of the input request API. If a policy matches a rule with an ALLOW action, the processing of the request proceeds forward. If it matches a rule with a DENY action, the processing of the request is terminated and an appropriate message/code returned to...",
|
|
7401
7408
|
"x-f5xc-minimum-configuration": {
|
|
7402
7409
|
"description": "Minimum configuration for policyRuleAction",
|
|
7403
7410
|
"required_fields": [],
|
|
@@ -7420,6 +7427,8 @@
|
|
|
7420
7427
|
"default": "FIRST_MATCH",
|
|
7421
7428
|
"x-displayname": "Rule Combining Algorithm.",
|
|
7422
7429
|
"x-ves-proto-enum": "ves.io.schema.policy.RuleCombiningAlgorithm",
|
|
7430
|
+
"x-f5xc-description-short": "The rule combining algorithm for a policy determines how the list of rules in the policy is evaluated.",
|
|
7431
|
+
"x-f5xc-description-medium": "The rule combining algorithm for a policy determines how the list of rules in the policy is evaluated. If any of the rules is configured with a App Firewall action, the rule combining algorithm must be configured to be FIRST_MATCH. - FIRST_MATCH Rules are evaluated sequentially till a matching...",
|
|
7423
7432
|
"x-f5xc-minimum-configuration": {
|
|
7424
7433
|
"description": "Minimum configuration for policyRuleCombiningAlgorithm",
|
|
7425
7434
|
"required_fields": [],
|
|
@@ -7448,6 +7457,8 @@
|
|
|
7448
7457
|
"default": "TRANSFORMER_NONE",
|
|
7449
7458
|
"x-displayname": "Transformer.",
|
|
7450
7459
|
"x-ves-proto-enum": "ves.io.schema.policy.Transformer",
|
|
7460
|
+
"x-f5xc-description-short": "Transformers to be applied on the part of the request before matching. - TRANSFORMER_NONE: transformer none No transformers enabled - LOWER_CASE...",
|
|
7461
|
+
"x-f5xc-description-medium": "Transformers to be applied on the part of the request before matching. - TRANSFORMER_NONE: transformer none No transformers enabled - LOWER_CASE: lower case Convert string to lower case - UPPER_CASE: upper case Convert string to upper case - BASE64_DECODE: base64 decode Decode string assuming...",
|
|
7451
7462
|
"x-f5xc-minimum-configuration": {
|
|
7452
7463
|
"description": "Minimum configuration for policyTransformer",
|
|
7453
7464
|
"required_fields": [],
|
|
@@ -7471,6 +7482,7 @@
|
|
|
7471
7482
|
"type": "string"
|
|
7472
7483
|
},
|
|
7473
7484
|
"x-f5xc-example": "['environment', 'location', 'deployment']",
|
|
7485
|
+
"x-f5xc-description-short": "X-displayName: \"Keys\" The list of label key names that have to match.",
|
|
7474
7486
|
"x-f5xc-required-for": {
|
|
7475
7487
|
"minimum_config": false,
|
|
7476
7488
|
"create": false,
|
|
@@ -7479,6 +7491,8 @@
|
|
|
7479
7491
|
}
|
|
7480
7492
|
}
|
|
7481
7493
|
},
|
|
7494
|
+
"x-f5xc-description-short": "X-displayName: \"Label Matcher\" A label matcher specifies a list of label keys whose values need to match for source/client and destination/server.",
|
|
7495
|
+
"x-f5xc-description-medium": "X-displayName: \"Label Matcher\" A label matcher specifies a list of label keys whose values need to match for source/client and destination/server. Note that the actual label values are not specified and do not matter. This allows an ability to scope grouping by the label key name.",
|
|
7482
7496
|
"x-f5xc-minimum-configuration": {
|
|
7483
7497
|
"description": "Minimum configuration for schemaLabelMatcherType",
|
|
7484
7498
|
"required_fields": [
|
|
@@ -7526,6 +7540,7 @@
|
|
|
7526
7540
|
"ves.io.schema.rules.repeated.items.string.min_len": "1",
|
|
7527
7541
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
7528
7542
|
},
|
|
7543
|
+
"x-f5xc-description-short": "Expressions contains the Kubernetes style label expression for selections. Required: YES.",
|
|
7529
7544
|
"x-f5xc-required-for": {
|
|
7530
7545
|
"minimum_config": false,
|
|
7531
7546
|
"create": false,
|
|
@@ -7534,6 +7549,8 @@
|
|
|
7534
7549
|
}
|
|
7535
7550
|
}
|
|
7536
7551
|
},
|
|
7552
|
+
"x-f5xc-description-short": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the...",
|
|
7553
|
+
"x-f5xc-description-medium": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expresssions. A label selector is a label query over a set of resources. An empty label selector matches all objects.",
|
|
7537
7554
|
"x-f5xc-minimum-configuration": {
|
|
7538
7555
|
"description": "Minimum configuration for schemaLabelSelectorType",
|
|
7539
7556
|
"required_fields": [
|
|
@@ -7571,6 +7588,8 @@
|
|
|
7571
7588
|
"x-validation-rules": {
|
|
7572
7589
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
7573
7590
|
},
|
|
7591
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
7592
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
7574
7593
|
"minLength": 0,
|
|
7575
7594
|
"x-f5xc-required-for": {
|
|
7576
7595
|
"minimum_config": false,
|
|
@@ -7586,6 +7605,8 @@
|
|
|
7586
7605
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
7587
7606
|
}
|
|
7588
7607
|
},
|
|
7608
|
+
"x-f5xc-description-short": "Secret_policy_rule object consists of an unordered list of predicates and an action.",
|
|
7609
|
+
"x-f5xc-description-medium": "Secret_policy_rule object consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from client certificate. A rule is considered to match if all predicates in the rule evaluate to true for that request.",
|
|
7589
7610
|
"x-f5xc-minimum-configuration": {
|
|
7590
7611
|
"description": "Minimum configuration for schemasecret_policy_ruleGlobalSpecType",
|
|
7591
7612
|
"required_fields": [
|
|
@@ -7612,6 +7633,8 @@
|
|
|
7612
7633
|
"$ref": "#/components/schemas/secret_managementPolicyData"
|
|
7613
7634
|
}
|
|
7614
7635
|
},
|
|
7636
|
+
"x-f5xc-description-short": "Policy Document contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7637
|
+
"x-f5xc-description-medium": "Policy Document contains the information about the secret policy and all the secret policy rules for the policy. This document can be given to F5 Distributed Cloud secret management tool to do secret encryption.",
|
|
7615
7638
|
"x-f5xc-minimum-configuration": {
|
|
7616
7639
|
"description": "Minimum configuration for secret_managementGetPolicyDocumentResponse",
|
|
7617
7640
|
"required_fields": [
|
|
@@ -7635,6 +7658,8 @@
|
|
|
7635
7658
|
"$ref": "#/components/schemas/secret_managementKeyData"
|
|
7636
7659
|
}
|
|
7637
7660
|
},
|
|
7661
|
+
"x-f5xc-description-short": "F5XC Secret Management uses asymmetric cryptography for securing secrets.",
|
|
7662
|
+
"x-f5xc-description-medium": "F5XC Secret Management uses asymmetric cryptography for securing secrets. Each tenant will be assigned a <public,private> keypair for secret management at registration time. While private part of the key never leaves F5 Distributed Cloud secret management, public part of this asymmetric key is...",
|
|
7638
7663
|
"x-f5xc-minimum-configuration": {
|
|
7639
7664
|
"description": "Minimum configuration for secret_managementGetPublicKeyResponse",
|
|
7640
7665
|
"required_fields": [
|
|
@@ -7656,7 +7681,7 @@
|
|
|
7656
7681
|
"properties": {
|
|
7657
7682
|
"key_version": {
|
|
7658
7683
|
"type": "integer",
|
|
7659
|
-
"description": "",
|
|
7684
|
+
"description": "Version number or identifier",
|
|
7660
7685
|
"title": "Key_version.",
|
|
7661
7686
|
"format": "int64",
|
|
7662
7687
|
"x-displayname": "Version of the key.",
|
|
@@ -7694,6 +7719,7 @@
|
|
|
7694
7719
|
"x-displayname": "Public Exponent.",
|
|
7695
7720
|
"x-ves-example": "Value",
|
|
7696
7721
|
"x-f5xc-example": "value",
|
|
7722
|
+
"x-f5xc-description-short": "Public Exponent as Base64 encoded string.",
|
|
7697
7723
|
"minLength": 0,
|
|
7698
7724
|
"maxLength": 1024,
|
|
7699
7725
|
"x-f5xc-required-for": {
|
|
@@ -7721,9 +7747,11 @@
|
|
|
7721
7747
|
"x-field-mutability": "read-only",
|
|
7722
7748
|
"x-original-maxLength": 1024,
|
|
7723
7749
|
"x-reconciled-from-discovery": true,
|
|
7724
|
-
"x-reconciled-at": "2026-01-
|
|
7750
|
+
"x-reconciled-at": "2026-01-07T15:53:17.902133+00:00"
|
|
7725
7751
|
}
|
|
7726
7752
|
},
|
|
7753
|
+
"x-f5xc-description-short": "F5XC Secret Management uses asymmetric cryptography for securing secrets.",
|
|
7754
|
+
"x-f5xc-description-medium": "F5XC Secret Management uses asymmetric cryptography for securing secrets. Each tenant will be assigned a <public,private> keypair for secret management at registration time. While private part of the key never leaves F5 Distributed Cloud secret management, public part of this asymmetric key is...",
|
|
7727
7755
|
"x-f5xc-minimum-configuration": {
|
|
7728
7756
|
"description": "Minimum configuration for secret_managementKeyData",
|
|
7729
7757
|
"required_fields": [
|
|
@@ -7763,7 +7791,7 @@
|
|
|
7763
7791
|
},
|
|
7764
7792
|
"x-original-maxLength": 1024,
|
|
7765
7793
|
"x-reconciled-from-discovery": true,
|
|
7766
|
-
"x-reconciled-at": "2026-01-
|
|
7794
|
+
"x-reconciled-at": "2026-01-07T15:53:17.902141+00:00"
|
|
7767
7795
|
},
|
|
7768
7796
|
"namespace": {
|
|
7769
7797
|
"type": "string",
|
|
@@ -7782,7 +7810,7 @@
|
|
|
7782
7810
|
},
|
|
7783
7811
|
"x-original-maxLength": 1024,
|
|
7784
7812
|
"x-reconciled-from-discovery": true,
|
|
7785
|
-
"x-reconciled-at": "2026-01-
|
|
7813
|
+
"x-reconciled-at": "2026-01-07T15:53:17.902146+00:00"
|
|
7786
7814
|
},
|
|
7787
7815
|
"policy_id": {
|
|
7788
7816
|
"type": "string",
|
|
@@ -7800,6 +7828,8 @@
|
|
|
7800
7828
|
"ves.io.schema.rules.uint64.gte": "0",
|
|
7801
7829
|
"ves.io.schema.rules.uint64.lte": "2147483647"
|
|
7802
7830
|
},
|
|
7831
|
+
"x-f5xc-description-short": "PolicyID for the policy. PolicyID is an integer ID which uniquely identifies the policy in given tenant.",
|
|
7832
|
+
"x-f5xc-description-medium": "PolicyID for the policy. PolicyID is an integer ID which uniquely identifies the policy in given tenant.",
|
|
7803
7833
|
"minLength": 0,
|
|
7804
7834
|
"maxLength": 1024,
|
|
7805
7835
|
"x-f5xc-required-for": {
|
|
@@ -7831,9 +7861,11 @@
|
|
|
7831
7861
|
"x-field-mutability": "read-only",
|
|
7832
7862
|
"x-original-maxLength": 1024,
|
|
7833
7863
|
"x-reconciled-from-discovery": true,
|
|
7834
|
-
"x-reconciled-at": "2026-01-
|
|
7864
|
+
"x-reconciled-at": "2026-01-07T15:53:17.902154+00:00"
|
|
7835
7865
|
}
|
|
7836
7866
|
},
|
|
7867
|
+
"x-f5xc-description-short": "Policy_data contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7868
|
+
"x-f5xc-description-medium": "Policy_data contains the information about the secret policy and all the secret policy rules for the policy.",
|
|
7837
7869
|
"x-f5xc-minimum-configuration": {
|
|
7838
7870
|
"description": "Minimum configuration for secret_managementPolicyData",
|
|
7839
7871
|
"required_fields": [
|
|
@@ -7868,6 +7900,9 @@
|
|
|
7868
7900
|
"$ref": "#/components/schemas/schemasecret_policy_ruleGlobalSpecType"
|
|
7869
7901
|
},
|
|
7870
7902
|
"x-displayname": "Secret Policy Rules.",
|
|
7903
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
7904
|
+
"x-f5xc-description-short": "List of references to secret_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
7905
|
+
"x-f5xc-description-medium": "List of references to secret_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
7871
7906
|
"x-f5xc-required-for": {
|
|
7872
7907
|
"minimum_config": false,
|
|
7873
7908
|
"create": false,
|
|
@@ -7876,6 +7911,7 @@
|
|
|
7876
7911
|
}
|
|
7877
7912
|
}
|
|
7878
7913
|
},
|
|
7914
|
+
"x-f5xc-description-short": "Policy_information contains the shape and specifications of the secret policy.",
|
|
7879
7915
|
"x-f5xc-minimum-configuration": {
|
|
7880
7916
|
"description": "Minimum configuration for secret_managementPolicyInfoType",
|
|
7881
7917
|
"required_fields": [
|
|
@@ -7901,6 +7937,8 @@
|
|
|
7901
7937
|
"$ref": "#/components/schemas/logFieldAggregation"
|
|
7902
7938
|
}
|
|
7903
7939
|
},
|
|
7940
|
+
"x-f5xc-description-short": "X-displayName: \"Aggregation Request\" Aggregation request to provide analytics data over the log response.",
|
|
7941
|
+
"x-f5xc-description-medium": "X-displayName: \"Aggregation Request\" Aggregation request to provide analytics data over the log response.",
|
|
7904
7942
|
"x-f5xc-minimum-configuration": {
|
|
7905
7943
|
"description": "Minimum configuration for logAggregationRequest",
|
|
7906
7944
|
"required_fields": [
|
|
@@ -7933,9 +7971,10 @@
|
|
|
7933
7971
|
"maxLength": 15,
|
|
7934
7972
|
"minLength": 3,
|
|
7935
7973
|
"x-reconciled-from-discovery": true,
|
|
7936
|
-
"x-reconciled-at": "2026-01-
|
|
7974
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331628+00:00"
|
|
7937
7975
|
}
|
|
7938
7976
|
},
|
|
7977
|
+
"x-f5xc-description-short": "X-displayName: \"Avg Aggregation Data\" Average Aggregation data.",
|
|
7939
7978
|
"x-f5xc-minimum-configuration": {
|
|
7940
7979
|
"description": "Minimum configuration for logAvgAggregationData",
|
|
7941
7980
|
"required_fields": [
|
|
@@ -7958,6 +7997,7 @@
|
|
|
7958
7997
|
"description": "X-displayName: \"Count\"\nx-example: 100\nCount of distinct values of a log field.",
|
|
7959
7998
|
"title": "Count",
|
|
7960
7999
|
"format": "uint64",
|
|
8000
|
+
"x-f5xc-example": "42",
|
|
7961
8001
|
"minLength": 0,
|
|
7962
8002
|
"maxLength": 1024,
|
|
7963
8003
|
"x-f5xc-required-for": {
|
|
@@ -7971,6 +8011,8 @@
|
|
|
7971
8011
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
7972
8012
|
}
|
|
7973
8013
|
},
|
|
8014
|
+
"x-f5xc-description-short": "X-displayName: \"Cardinality Aggregation Data\" Approximate count of distinct values of the log field specified in the request.",
|
|
8015
|
+
"x-f5xc-description-medium": "X-displayName: \"Cardinality Aggregation Data\" Approximate count of distinct values of the log field specified in the request.",
|
|
7974
8016
|
"x-f5xc-minimum-configuration": {
|
|
7975
8017
|
"description": "Minimum configuration for logCardinalityAggregationData",
|
|
7976
8018
|
"required_fields": [
|
|
@@ -7994,6 +8036,8 @@
|
|
|
7994
8036
|
"description": "X-displayName: \"Step\"\nx-required\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
7995
8037
|
"title": "Step",
|
|
7996
8038
|
"x-f5xc-example": "5m",
|
|
8039
|
+
"x-f5xc-description-short": "X-displayName: \"Step\" x-required step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in...",
|
|
8040
|
+
"x-f5xc-description-medium": "X-displayName: \"Step\" x-required step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
7997
8041
|
"minLength": 0,
|
|
7998
8042
|
"maxLength": 1024,
|
|
7999
8043
|
"x-f5xc-required-for": {
|
|
@@ -8007,6 +8051,7 @@
|
|
|
8007
8051
|
"type": "object",
|
|
8008
8052
|
"description": "X-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket.",
|
|
8009
8053
|
"title": "Sub aggregation.",
|
|
8054
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" This option provides sub-aggregation for each date bucket.",
|
|
8010
8055
|
"x-f5xc-required-for": {
|
|
8011
8056
|
"minimum_config": false,
|
|
8012
8057
|
"create": false,
|
|
@@ -8015,6 +8060,7 @@
|
|
|
8015
8060
|
}
|
|
8016
8061
|
}
|
|
8017
8062
|
},
|
|
8063
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation\" Aggregate access logs based on timestamp in the log.",
|
|
8018
8064
|
"x-f5xc-minimum-configuration": {
|
|
8019
8065
|
"description": "Minimum configuration for logDateAggregation",
|
|
8020
8066
|
"required_fields": [
|
|
@@ -8038,6 +8084,7 @@
|
|
|
8038
8084
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8039
8085
|
"title": "Count",
|
|
8040
8086
|
"format": "uint64",
|
|
8087
|
+
"x-f5xc-example": "42",
|
|
8041
8088
|
"minLength": 0,
|
|
8042
8089
|
"maxLength": 1024,
|
|
8043
8090
|
"x-f5xc-required-for": {
|
|
@@ -8051,6 +8098,7 @@
|
|
|
8051
8098
|
"type": "object",
|
|
8052
8099
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the date bucket.",
|
|
8053
8100
|
"title": "Sub aggregation.",
|
|
8101
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the date bucket.",
|
|
8054
8102
|
"x-f5xc-required-for": {
|
|
8055
8103
|
"minimum_config": false,
|
|
8056
8104
|
"create": false,
|
|
@@ -8076,6 +8124,8 @@
|
|
|
8076
8124
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
8077
8125
|
}
|
|
8078
8126
|
},
|
|
8127
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation Bucket\" Date histogram bucket containing the timestamp and the number of logs in that bucket.",
|
|
8128
|
+
"x-f5xc-description-medium": "X-displayName: \"Date Aggregation Bucket\" Date histogram bucket containing the timestamp and the number of logs in that bucket.",
|
|
8079
8129
|
"x-f5xc-minimum-configuration": {
|
|
8080
8130
|
"description": "Minimum configuration for logDateAggregationBucket",
|
|
8081
8131
|
"required_fields": [
|
|
@@ -8103,6 +8153,7 @@
|
|
|
8103
8153
|
"items": {
|
|
8104
8154
|
"$ref": "#/components/schemas/logDateAggregationBucket"
|
|
8105
8155
|
},
|
|
8156
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing timestamp and the corresponding log count.",
|
|
8106
8157
|
"x-f5xc-required-for": {
|
|
8107
8158
|
"minimum_config": false,
|
|
8108
8159
|
"create": false,
|
|
@@ -8115,6 +8166,8 @@
|
|
|
8115
8166
|
"description": "X-displayName: \"Step\"\nActual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
8116
8167
|
"title": "Step",
|
|
8117
8168
|
"x-f5xc-example": "30m",
|
|
8169
|
+
"x-f5xc-description-short": "X-displayName: \"Step\" Actual step size in the response.",
|
|
8170
|
+
"x-f5xc-description-medium": "X-displayName: \"Step\" Actual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
8118
8171
|
"minLength": 0,
|
|
8119
8172
|
"maxLength": 1024,
|
|
8120
8173
|
"x-f5xc-required-for": {
|
|
@@ -8125,6 +8178,7 @@
|
|
|
8125
8178
|
}
|
|
8126
8179
|
}
|
|
8127
8180
|
},
|
|
8181
|
+
"x-f5xc-description-short": "X-displayName: \"Date Aggregation Data\" Date aggregation data.",
|
|
8128
8182
|
"x-f5xc-minimum-configuration": {
|
|
8129
8183
|
"description": "Minimum configuration for logDateAggregationData",
|
|
8130
8184
|
"required_fields": [
|
|
@@ -8147,6 +8201,8 @@
|
|
|
8147
8201
|
"$ref": "#/components/schemas/logFieldAggregation"
|
|
8148
8202
|
}
|
|
8149
8203
|
},
|
|
8204
|
+
"x-f5xc-description-short": "X-displayName: \"Date SubAggregation\" Aggregate audit logs based on one of the sub aggregation types.",
|
|
8205
|
+
"x-f5xc-description-medium": "X-displayName: \"Date SubAggregation\" Aggregate audit logs based on one of the sub aggregation types.",
|
|
8150
8206
|
"x-f5xc-minimum-configuration": {
|
|
8151
8207
|
"description": "Minimum configuration for logDateSubAggregation",
|
|
8152
8208
|
"required_fields": [
|
|
@@ -8171,6 +8227,7 @@
|
|
|
8171
8227
|
"$ref": "#/components/schemas/logMultiFieldAggregationData"
|
|
8172
8228
|
}
|
|
8173
8229
|
},
|
|
8230
|
+
"x-f5xc-description-short": "X-displayName: \"Date SubAggregation\" Date subaggregation data.",
|
|
8174
8231
|
"x-f5xc-minimum-configuration": {
|
|
8175
8232
|
"description": "Minimum configuration for logDateSubAggregationData",
|
|
8176
8233
|
"required_fields": [
|
|
@@ -8198,6 +8255,8 @@
|
|
|
8198
8255
|
"title": "Topk",
|
|
8199
8256
|
"format": "int64",
|
|
8200
8257
|
"x-f5xc-example": "5",
|
|
8258
|
+
"x-f5xc-description-short": "X-displayName: \"TopK\" Number of top field values to be returned in the response.",
|
|
8259
|
+
"x-f5xc-description-medium": "X-displayName: \"TopK\" Number of top field values to be returned in the response. Optional: If not specified, top 5 values will be returned in the response.",
|
|
8201
8260
|
"minimum": 0,
|
|
8202
8261
|
"maximum": 2147483647,
|
|
8203
8262
|
"x-f5xc-required-for": {
|
|
@@ -8208,6 +8267,7 @@
|
|
|
8208
8267
|
}
|
|
8209
8268
|
}
|
|
8210
8269
|
},
|
|
8270
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation\" Aggregate audit logs based on the key fields in the log.",
|
|
8211
8271
|
"x-f5xc-minimum-configuration": {
|
|
8212
8272
|
"description": "Minimum configuration for logFieldAggregation",
|
|
8213
8273
|
"required_fields": [
|
|
@@ -8231,6 +8291,7 @@
|
|
|
8231
8291
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8232
8292
|
"title": "Count",
|
|
8233
8293
|
"format": "uint64",
|
|
8294
|
+
"x-f5xc-example": "42",
|
|
8234
8295
|
"minLength": 0,
|
|
8235
8296
|
"maxLength": 1024,
|
|
8236
8297
|
"x-f5xc-required-for": {
|
|
@@ -8255,7 +8316,7 @@
|
|
|
8255
8316
|
},
|
|
8256
8317
|
"x-original-maxLength": 1024,
|
|
8257
8318
|
"x-reconciled-from-discovery": true,
|
|
8258
|
-
"x-reconciled-at": "2026-01-
|
|
8319
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331663+00:00"
|
|
8259
8320
|
},
|
|
8260
8321
|
"order_by": {
|
|
8261
8322
|
"$ref": "#/components/schemas/logOrderByData"
|
|
@@ -8264,6 +8325,7 @@
|
|
|
8264
8325
|
"type": "object",
|
|
8265
8326
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the field aggregation bucket.",
|
|
8266
8327
|
"title": "Sub aggregation.",
|
|
8328
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the field aggregation bucket.",
|
|
8267
8329
|
"x-f5xc-required-for": {
|
|
8268
8330
|
"minimum_config": false,
|
|
8269
8331
|
"create": false,
|
|
@@ -8275,6 +8337,8 @@
|
|
|
8275
8337
|
"$ref": "#/components/schemas/schemaTrendValue"
|
|
8276
8338
|
}
|
|
8277
8339
|
},
|
|
8340
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation Bucket\" Field aggregation bucket containing field value and the number of logs.",
|
|
8341
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Aggregation Bucket\" Field aggregation bucket containing field value and the number of logs.",
|
|
8278
8342
|
"x-f5xc-minimum-configuration": {
|
|
8279
8343
|
"description": "Minimum configuration for logFieldAggregationBucket",
|
|
8280
8344
|
"required_fields": [
|
|
@@ -8303,6 +8367,7 @@
|
|
|
8303
8367
|
"items": {
|
|
8304
8368
|
"$ref": "#/components/schemas/logFieldAggregationBucket"
|
|
8305
8369
|
},
|
|
8370
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8306
8371
|
"x-f5xc-required-for": {
|
|
8307
8372
|
"minimum_config": false,
|
|
8308
8373
|
"create": false,
|
|
@@ -8311,6 +8376,7 @@
|
|
|
8311
8376
|
}
|
|
8312
8377
|
}
|
|
8313
8378
|
},
|
|
8379
|
+
"x-f5xc-description-short": "X-displayName: \"Field Aggregation Data\" Field Aggregation data.",
|
|
8314
8380
|
"x-f5xc-minimum-configuration": {
|
|
8315
8381
|
"description": "Minimum configuration for logFieldAggregationData",
|
|
8316
8382
|
"required_fields": [
|
|
@@ -8333,6 +8399,7 @@
|
|
|
8333
8399
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8334
8400
|
"title": "Count",
|
|
8335
8401
|
"format": "uint64",
|
|
8402
|
+
"x-f5xc-example": "42",
|
|
8336
8403
|
"minLength": 0,
|
|
8337
8404
|
"maxLength": 1024,
|
|
8338
8405
|
"x-f5xc-required-for": {
|
|
@@ -8347,6 +8414,7 @@
|
|
|
8347
8414
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8348
8415
|
"title": "Keys",
|
|
8349
8416
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8417
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8350
8418
|
"minLength": 0,
|
|
8351
8419
|
"maxLength": 16,
|
|
8352
8420
|
"x-f5xc-required-for": {
|
|
@@ -8357,12 +8425,14 @@
|
|
|
8357
8425
|
},
|
|
8358
8426
|
"x-original-maxLength": 1024,
|
|
8359
8427
|
"x-reconciled-from-discovery": true,
|
|
8360
|
-
"x-reconciled-at": "2026-01-
|
|
8428
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331676+00:00"
|
|
8361
8429
|
},
|
|
8362
8430
|
"order_by": {
|
|
8363
8431
|
"$ref": "#/components/schemas/logOrderByData"
|
|
8364
8432
|
}
|
|
8365
8433
|
},
|
|
8434
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8435
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Sub Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8366
8436
|
"x-f5xc-minimum-configuration": {
|
|
8367
8437
|
"description": "Minimum configuration for logFieldSubAggregationBucket",
|
|
8368
8438
|
"required_fields": [
|
|
@@ -8392,6 +8462,7 @@
|
|
|
8392
8462
|
"items": {
|
|
8393
8463
|
"$ref": "#/components/schemas/logFieldSubAggregationBucket"
|
|
8394
8464
|
},
|
|
8465
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field values and the corresponding log count.",
|
|
8395
8466
|
"x-f5xc-required-for": {
|
|
8396
8467
|
"minimum_config": false,
|
|
8397
8468
|
"create": false,
|
|
@@ -8415,6 +8486,7 @@
|
|
|
8415
8486
|
"$ref": "#/components/schemas/logMultiFilterAggregationData"
|
|
8416
8487
|
}
|
|
8417
8488
|
},
|
|
8489
|
+
"x-f5xc-description-short": "X-displayName: \"Field SubAggregation\" Field subaggregation data.",
|
|
8418
8490
|
"x-f5xc-minimum-configuration": {
|
|
8419
8491
|
"description": "Minimum configuration for logFieldSubAggregationData",
|
|
8420
8492
|
"required_fields": [
|
|
@@ -8443,6 +8515,7 @@
|
|
|
8443
8515
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8444
8516
|
"title": "Count",
|
|
8445
8517
|
"format": "uint64",
|
|
8518
|
+
"x-f5xc-example": "42",
|
|
8446
8519
|
"minLength": 0,
|
|
8447
8520
|
"maxLength": 1024,
|
|
8448
8521
|
"x-f5xc-required-for": {
|
|
@@ -8457,6 +8530,7 @@
|
|
|
8457
8530
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8458
8531
|
"title": "Keys",
|
|
8459
8532
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8533
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8460
8534
|
"minLength": 0,
|
|
8461
8535
|
"maxLength": 16,
|
|
8462
8536
|
"x-f5xc-required-for": {
|
|
@@ -8467,9 +8541,11 @@
|
|
|
8467
8541
|
},
|
|
8468
8542
|
"x-original-maxLength": 1024,
|
|
8469
8543
|
"x-reconciled-from-discovery": true,
|
|
8470
|
-
"x-reconciled-at": "2026-01-
|
|
8544
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331691+00:00"
|
|
8471
8545
|
}
|
|
8472
8546
|
},
|
|
8547
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8548
|
+
"x-f5xc-description-medium": "X-displayName: \"Field Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8473
8549
|
"x-f5xc-minimum-configuration": {
|
|
8474
8550
|
"description": "Minimum configuration for logFieldSubFieldAggregationBucket",
|
|
8475
8551
|
"required_fields": [
|
|
@@ -8495,6 +8571,7 @@
|
|
|
8495
8571
|
"items": {
|
|
8496
8572
|
"$ref": "#/components/schemas/logFieldSubFieldAggregationBucket"
|
|
8497
8573
|
},
|
|
8574
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8498
8575
|
"x-f5xc-required-for": {
|
|
8499
8576
|
"minimum_config": false,
|
|
8500
8577
|
"create": false,
|
|
@@ -8503,6 +8580,7 @@
|
|
|
8503
8580
|
}
|
|
8504
8581
|
}
|
|
8505
8582
|
},
|
|
8583
|
+
"x-f5xc-description-short": "X-displayName: \"Field Sub Field Aggregation Data\" Field Aggregation data as Field Sub-aggregation.",
|
|
8506
8584
|
"x-f5xc-minimum-configuration": {
|
|
8507
8585
|
"description": "Minimum configuration for logFieldSubFieldAggregationData",
|
|
8508
8586
|
"required_fields": [
|
|
@@ -8525,6 +8603,7 @@
|
|
|
8525
8603
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8526
8604
|
"title": "Count",
|
|
8527
8605
|
"format": "uint64",
|
|
8606
|
+
"x-f5xc-example": "42",
|
|
8528
8607
|
"minLength": 0,
|
|
8529
8608
|
"maxLength": 1024,
|
|
8530
8609
|
"x-f5xc-required-for": {
|
|
@@ -8538,6 +8617,7 @@
|
|
|
8538
8617
|
"type": "object",
|
|
8539
8618
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation.",
|
|
8540
8619
|
"title": "Sub aggregation.",
|
|
8620
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the filter aggregation.",
|
|
8541
8621
|
"x-f5xc-required-for": {
|
|
8542
8622
|
"minimum_config": false,
|
|
8543
8623
|
"create": false,
|
|
@@ -8546,6 +8626,7 @@
|
|
|
8546
8626
|
}
|
|
8547
8627
|
}
|
|
8548
8628
|
},
|
|
8629
|
+
"x-f5xc-description-short": "X-displayName: \"Filter Aggregation Data\" Filter Aggregation Data.",
|
|
8549
8630
|
"x-f5xc-minimum-configuration": {
|
|
8550
8631
|
"description": "Minimum configuration for logFilterAggregationData",
|
|
8551
8632
|
"required_fields": [
|
|
@@ -8571,6 +8652,7 @@
|
|
|
8571
8652
|
"items": {
|
|
8572
8653
|
"$ref": "#/components/schemas/logFilterSubFieldAggregationBucket"
|
|
8573
8654
|
},
|
|
8655
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field value and the corresponding log count.",
|
|
8574
8656
|
"x-f5xc-required-for": {
|
|
8575
8657
|
"minimum_config": false,
|
|
8576
8658
|
"create": false,
|
|
@@ -8579,6 +8661,7 @@
|
|
|
8579
8661
|
}
|
|
8580
8662
|
}
|
|
8581
8663
|
},
|
|
8664
|
+
"x-f5xc-description-short": "X-displayName: \"FilterSubAggregation\" Filter subaggregation data.",
|
|
8582
8665
|
"x-f5xc-minimum-configuration": {
|
|
8583
8666
|
"description": "Minimum configuration for logFilterSubAggregationData",
|
|
8584
8667
|
"required_fields": [
|
|
@@ -8601,6 +8684,7 @@
|
|
|
8601
8684
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8602
8685
|
"title": "Count",
|
|
8603
8686
|
"format": "uint64",
|
|
8687
|
+
"x-f5xc-example": "42",
|
|
8604
8688
|
"minLength": 0,
|
|
8605
8689
|
"maxLength": 1024,
|
|
8606
8690
|
"x-f5xc-required-for": {
|
|
@@ -8615,6 +8699,7 @@
|
|
|
8615
8699
|
"description": "X-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields.",
|
|
8616
8700
|
"title": "Keys",
|
|
8617
8701
|
"x-f5xc-example": "HIT, MISS, REVALIDATED",
|
|
8702
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key contain the name/value pair that identifies the unique key fields.",
|
|
8618
8703
|
"minLength": 0,
|
|
8619
8704
|
"maxLength": 16,
|
|
8620
8705
|
"x-f5xc-required-for": {
|
|
@@ -8625,12 +8710,13 @@
|
|
|
8625
8710
|
},
|
|
8626
8711
|
"x-original-maxLength": 1024,
|
|
8627
8712
|
"x-reconciled-from-discovery": true,
|
|
8628
|
-
"x-reconciled-at": "2026-01-
|
|
8713
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331704+00:00"
|
|
8629
8714
|
},
|
|
8630
8715
|
"sub_aggs": {
|
|
8631
8716
|
"type": "object",
|
|
8632
8717
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation.",
|
|
8633
8718
|
"title": "Sub aggregation.",
|
|
8719
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the filter aggregation.",
|
|
8634
8720
|
"x-f5xc-required-for": {
|
|
8635
8721
|
"minimum_config": false,
|
|
8636
8722
|
"create": false,
|
|
@@ -8639,6 +8725,8 @@
|
|
|
8639
8725
|
}
|
|
8640
8726
|
}
|
|
8641
8727
|
},
|
|
8728
|
+
"x-f5xc-description-short": "X-displayName: \"Filter Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8729
|
+
"x-f5xc-description-medium": "X-displayName: \"Filter Sub Field Aggregation Bucket\" Field sub aggregation bucket containing field values and the number of logs.",
|
|
8642
8730
|
"x-f5xc-minimum-configuration": {
|
|
8643
8731
|
"description": "Minimum configuration for logFilterSubFieldAggregationBucket",
|
|
8644
8732
|
"required_fields": [
|
|
@@ -8671,6 +8759,8 @@
|
|
|
8671
8759
|
"USER"
|
|
8672
8760
|
],
|
|
8673
8761
|
"default": "ASN",
|
|
8762
|
+
"x-f5xc-description-short": "X-displayName: \"Key Field\" Fields that can be specified in the field aggregation. - ASN: x-displayName: \"ASN number\" - AUTHOR_TENANT...",
|
|
8763
|
+
"x-f5xc-description-medium": "X-displayName: \"Key Field\" Fields that can be specified in the field aggregation. - ASN: x-displayName: \"ASN number\" - AUTHOR_TENANT: x-displayName: \"Author Tenant\" - BROWSER_TYPE: x-displayName: \"Browser Type\" - CITY: x-displayName: \"City\" - COUNTRY: x-displayName: \"Country\" - DEVICE_TYPE...",
|
|
8674
8764
|
"x-f5xc-minimum-configuration": {
|
|
8675
8765
|
"description": "Minimum configuration for logKeyField",
|
|
8676
8766
|
"required_fields": [],
|
|
@@ -8717,6 +8807,7 @@
|
|
|
8717
8807
|
"$ref": "#/components/schemas/logMultiFilterAggregationData"
|
|
8718
8808
|
}
|
|
8719
8809
|
},
|
|
8810
|
+
"x-f5xc-description-short": "X-displayName: \"Log Aggregation\" Log aggregation response data.",
|
|
8720
8811
|
"x-f5xc-minimum-configuration": {
|
|
8721
8812
|
"description": "Minimum configuration for logLogAggregationData",
|
|
8722
8813
|
"required_fields": [
|
|
@@ -8757,9 +8848,10 @@
|
|
|
8757
8848
|
"maxLength": 15,
|
|
8758
8849
|
"minLength": 3,
|
|
8759
8850
|
"x-reconciled-from-discovery": true,
|
|
8760
|
-
"x-reconciled-at": "2026-01-
|
|
8851
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331723+00:00"
|
|
8761
8852
|
}
|
|
8762
8853
|
},
|
|
8854
|
+
"x-f5xc-description-short": "X-displayName: \"Max Aggregation Data\" Max Aggregation data.",
|
|
8763
8855
|
"x-f5xc-minimum-configuration": {
|
|
8764
8856
|
"description": "Minimum configuration for logMaxAggregationData",
|
|
8765
8857
|
"required_fields": [
|
|
@@ -8781,6 +8873,7 @@
|
|
|
8781
8873
|
"$ref": "#/components/schemas/logPercentileAggregationData"
|
|
8782
8874
|
}
|
|
8783
8875
|
},
|
|
8876
|
+
"x-f5xc-description-short": "X-displayName: \"Metrics Aggregation\" Metrics aggregation data.",
|
|
8784
8877
|
"x-f5xc-minimum-configuration": {
|
|
8785
8878
|
"description": "Minimum configuration for logMetricsAggregationData",
|
|
8786
8879
|
"required_fields": [
|
|
@@ -8812,9 +8905,10 @@
|
|
|
8812
8905
|
"maxLength": 15,
|
|
8813
8906
|
"minLength": 3,
|
|
8814
8907
|
"x-reconciled-from-discovery": true,
|
|
8815
|
-
"x-reconciled-at": "2026-01-
|
|
8908
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331730+00:00"
|
|
8816
8909
|
}
|
|
8817
8910
|
},
|
|
8911
|
+
"x-f5xc-description-short": "X-displayName: \"Min Aggregation Data\" Min Aggregation data.",
|
|
8818
8912
|
"x-f5xc-minimum-configuration": {
|
|
8819
8913
|
"description": "Minimum configuration for logMinAggregationData",
|
|
8820
8914
|
"required_fields": [
|
|
@@ -8837,6 +8931,7 @@
|
|
|
8837
8931
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8838
8932
|
"title": "Count",
|
|
8839
8933
|
"format": "uint64",
|
|
8934
|
+
"x-f5xc-example": "42",
|
|
8840
8935
|
"minLength": 0,
|
|
8841
8936
|
"maxLength": 1024,
|
|
8842
8937
|
"x-f5xc-required-for": {
|
|
@@ -8851,6 +8946,8 @@
|
|
|
8851
8946
|
"description": "X-displayName: \"Keys\"\nKeys contain the name/value pair that identifies the unique combination of multiple key fields\nSRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\"",
|
|
8852
8947
|
"title": "Keys",
|
|
8853
8948
|
"x-f5xc-example": "{",
|
|
8949
|
+
"x-f5xc-description-short": "X-displayName: \"Keys\" Keys contain the name/value pair that identifies the unique combination of multiple key fields SRC_IP\": \"10.10.10.1\"...",
|
|
8950
|
+
"x-f5xc-description-medium": "X-displayName: \"Keys\" Keys contain the name/value pair that identifies the unique combination of multiple key fields SRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\".",
|
|
8854
8951
|
"x-f5xc-required-for": {
|
|
8855
8952
|
"minimum_config": false,
|
|
8856
8953
|
"create": false,
|
|
@@ -8865,6 +8962,7 @@
|
|
|
8865
8962
|
"type": "object",
|
|
8866
8963
|
"description": "X-displayName: \"Sub Aggregation\"\nSub aggregation data for the multi field aggregation bucket.",
|
|
8867
8964
|
"title": "Sub aggregation.",
|
|
8965
|
+
"x-f5xc-description-short": "X-displayName: \"Sub Aggregation\" Sub aggregation data for the multi field aggregation bucket.",
|
|
8868
8966
|
"x-f5xc-required-for": {
|
|
8869
8967
|
"minimum_config": false,
|
|
8870
8968
|
"create": false,
|
|
@@ -8873,6 +8971,8 @@
|
|
|
8873
8971
|
}
|
|
8874
8972
|
}
|
|
8875
8973
|
},
|
|
8974
|
+
"x-f5xc-description-short": "X-displayName: \"Multi-Field Aggregation Bucket\" Multi-Field aggregation bucket containing field values and the number of logs.",
|
|
8975
|
+
"x-f5xc-description-medium": "X-displayName: \"Multi-Field Aggregation Bucket\" Multi-Field aggregation bucket containing field values and the number of logs.",
|
|
8876
8976
|
"x-f5xc-minimum-configuration": {
|
|
8877
8977
|
"description": "Minimum configuration for logMultiFieldAggregationBucket",
|
|
8878
8978
|
"required_fields": [
|
|
@@ -8900,6 +9000,7 @@
|
|
|
8900
9000
|
"items": {
|
|
8901
9001
|
"$ref": "#/components/schemas/logMultiFieldAggregationBucket"
|
|
8902
9002
|
},
|
|
9003
|
+
"x-f5xc-description-short": "X-displayName: \"Buckets\" Lists of buckets containing field values and the corresponding log count.",
|
|
8903
9004
|
"x-f5xc-required-for": {
|
|
8904
9005
|
"minimum_config": false,
|
|
8905
9006
|
"create": false,
|
|
@@ -8908,6 +9009,7 @@
|
|
|
8908
9009
|
}
|
|
8909
9010
|
}
|
|
8910
9011
|
},
|
|
9012
|
+
"x-f5xc-description-short": "X-displayName: \"Multi-Field Aggregation Data\" Multi-Field Aggregation data.",
|
|
8911
9013
|
"x-f5xc-minimum-configuration": {
|
|
8912
9014
|
"description": "Minimum configuration for logMultiFieldAggregationData",
|
|
8913
9015
|
"required_fields": [
|
|
@@ -8941,6 +9043,7 @@
|
|
|
8941
9043
|
"$ref": "#/components/schemas/logTopHitsAggregationData"
|
|
8942
9044
|
}
|
|
8943
9045
|
},
|
|
9046
|
+
"x-f5xc-description-short": "X-displayName: \"Multi Field SubAggregation\" Field subaggregation data.",
|
|
8944
9047
|
"x-f5xc-minimum-configuration": {
|
|
8945
9048
|
"description": "Minimum configuration for logMultiFieldSubAggregationData",
|
|
8946
9049
|
"required_fields": [
|
|
@@ -8967,6 +9070,7 @@
|
|
|
8967
9070
|
"description": "X-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket.",
|
|
8968
9071
|
"title": "Count",
|
|
8969
9072
|
"format": "uint64",
|
|
9073
|
+
"x-f5xc-example": "42",
|
|
8970
9074
|
"minLength": 0,
|
|
8971
9075
|
"maxLength": 1024,
|
|
8972
9076
|
"x-f5xc-required-for": {
|
|
@@ -8977,6 +9081,7 @@
|
|
|
8977
9081
|
}
|
|
8978
9082
|
}
|
|
8979
9083
|
},
|
|
9084
|
+
"x-f5xc-description-short": "X-displayName: \"Multi Filter Aggregation Data\" Multi Filter Aggregation data.",
|
|
8980
9085
|
"x-f5xc-minimum-configuration": {
|
|
8981
9086
|
"description": "Minimum configuration for logMultiFilterAggregationData",
|
|
8982
9087
|
"required_fields": [
|
|
@@ -8998,6 +9103,7 @@
|
|
|
8998
9103
|
"$ref": "#/components/schemas/logMetricsAggregationData"
|
|
8999
9104
|
}
|
|
9000
9105
|
},
|
|
9106
|
+
"x-f5xc-description-short": "X-displayName: \"Order by Data\" Order by data.",
|
|
9001
9107
|
"x-f5xc-minimum-configuration": {
|
|
9002
9108
|
"description": "Minimum configuration for logOrderByData",
|
|
9003
9109
|
"required_fields": [
|
|
@@ -9020,6 +9126,7 @@
|
|
|
9020
9126
|
"description": "X-displayName: \"Key\"\nx-example: 99.0.",
|
|
9021
9127
|
"title": "Key",
|
|
9022
9128
|
"format": "double",
|
|
9129
|
+
"x-f5xc-example": "[REDACTED_PUBLIC_KEY]",
|
|
9023
9130
|
"x-f5xc-required-for": {
|
|
9024
9131
|
"minimum_config": false,
|
|
9025
9132
|
"create": false,
|
|
@@ -9029,7 +9136,7 @@
|
|
|
9029
9136
|
"maxLength": 16,
|
|
9030
9137
|
"minLength": 7,
|
|
9031
9138
|
"x-reconciled-from-discovery": true,
|
|
9032
|
-
"x-reconciled-at": "2026-01-
|
|
9139
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331752+00:00"
|
|
9033
9140
|
},
|
|
9034
9141
|
"value": {
|
|
9035
9142
|
"type": "number",
|
|
@@ -9045,9 +9152,10 @@
|
|
|
9045
9152
|
"maxLength": 15,
|
|
9046
9153
|
"minLength": 3,
|
|
9047
9154
|
"x-reconciled-from-discovery": true,
|
|
9048
|
-
"x-reconciled-at": "2026-01-
|
|
9155
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331757+00:00"
|
|
9049
9156
|
}
|
|
9050
9157
|
},
|
|
9158
|
+
"x-f5xc-description-short": "X-displayName: \"Percentile Aggregation Data\" Percentile Aggregation data.",
|
|
9051
9159
|
"x-f5xc-minimum-configuration": {
|
|
9052
9160
|
"description": "Minimum configuration for logPercentileAggregationData",
|
|
9053
9161
|
"required_fields": [
|
|
@@ -9071,6 +9179,7 @@
|
|
|
9071
9179
|
"description": "X-displayName: \"Count\"\nx-example: 100\nCount of top hit values.",
|
|
9072
9180
|
"title": "Count",
|
|
9073
9181
|
"format": "uint64",
|
|
9182
|
+
"x-f5xc-example": "42",
|
|
9074
9183
|
"minLength": 0,
|
|
9075
9184
|
"maxLength": 1024,
|
|
9076
9185
|
"x-f5xc-required-for": {
|
|
@@ -9087,6 +9196,7 @@
|
|
|
9087
9196
|
"items": {
|
|
9088
9197
|
"type": "string"
|
|
9089
9198
|
},
|
|
9199
|
+
"x-f5xc-description-short": "X-displayName: \"Documents\" document values.",
|
|
9090
9200
|
"x-f5xc-required-for": {
|
|
9091
9201
|
"minimum_config": false,
|
|
9092
9202
|
"create": false,
|
|
@@ -9095,6 +9205,7 @@
|
|
|
9095
9205
|
}
|
|
9096
9206
|
}
|
|
9097
9207
|
},
|
|
9208
|
+
"x-f5xc-description-short": "X-displayName: \"TopHits Aggregation Data\" Top Hits Aggregation Data.",
|
|
9098
9209
|
"x-f5xc-minimum-configuration": {
|
|
9099
9210
|
"description": "Minimum configuration for logTopHitsAggregationData",
|
|
9100
9211
|
"required_fields": [
|
|
@@ -9134,6 +9245,8 @@
|
|
|
9134
9245
|
}
|
|
9135
9246
|
}
|
|
9136
9247
|
},
|
|
9248
|
+
"x-f5xc-description-short": "VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.",
|
|
9249
|
+
"x-f5xc-description-medium": "VoltShareAccessCounter contains the access count for each unique combination of group_by label in the request.",
|
|
9137
9250
|
"x-f5xc-minimum-configuration": {
|
|
9138
9251
|
"description": "Minimum configuration for metricsVoltShareAccessCounter",
|
|
9139
9252
|
"required_fields": [
|
|
@@ -9161,6 +9274,7 @@
|
|
|
9161
9274
|
"x-displayname": "Country",
|
|
9162
9275
|
"x-ves-example": "US",
|
|
9163
9276
|
"x-f5xc-example": "US",
|
|
9277
|
+
"x-f5xc-description-short": "Country from where the API call was made.",
|
|
9164
9278
|
"minLength": 0,
|
|
9165
9279
|
"maxLength": 1024,
|
|
9166
9280
|
"x-f5xc-required-for": {
|
|
@@ -9209,6 +9323,7 @@
|
|
|
9209
9323
|
"x-displayname": "User Tenant.",
|
|
9210
9324
|
"x-ves-example": "Customer1",
|
|
9211
9325
|
"x-f5xc-example": "customer1",
|
|
9326
|
+
"x-f5xc-description-short": "Tenant that made the VoltShare API call.",
|
|
9212
9327
|
"minLength": 0,
|
|
9213
9328
|
"maxLength": 1024,
|
|
9214
9329
|
"x-f5xc-required-for": {
|
|
@@ -9219,6 +9334,8 @@
|
|
|
9219
9334
|
}
|
|
9220
9335
|
}
|
|
9221
9336
|
},
|
|
9337
|
+
"x-f5xc-description-short": "VoltShareAccessId uniquely identifies an entry in the response.",
|
|
9338
|
+
"x-f5xc-description-medium": "VoltShareAccessId uniquely identifies an entry in the response. VoltShare access count is aggregated based on the MetricLabel specified in the group_by field in the request. Therefore, only the fields that corresponds to the MetricLabel in the group_by will have non-empty value in the response.",
|
|
9222
9339
|
"x-f5xc-minimum-configuration": {
|
|
9223
9340
|
"description": "Minimum configuration for metricsVoltShareAccessId",
|
|
9224
9341
|
"required_fields": [
|
|
@@ -9247,6 +9364,7 @@
|
|
|
9247
9364
|
"default": "OPERATION",
|
|
9248
9365
|
"x-displayname": "VoltShare Access Metric Labels.",
|
|
9249
9366
|
"x-ves-proto-enum": "ves.io.schema.voltshare.metrics.VoltShareMetricLabel",
|
|
9367
|
+
"x-f5xc-description-short": "VoltShare Access metric can be sliced and diced based on one or more labels listed below.",
|
|
9250
9368
|
"x-f5xc-minimum-configuration": {
|
|
9251
9369
|
"description": "Minimum configuration for metricsVoltShareMetricLabel",
|
|
9252
9370
|
"required_fields": [],
|
|
@@ -9287,9 +9405,11 @@
|
|
|
9287
9405
|
},
|
|
9288
9406
|
"x-original-maxLength": 1024,
|
|
9289
9407
|
"x-reconciled-from-discovery": true,
|
|
9290
|
-
"x-reconciled-at": "2026-01-
|
|
9408
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331777+00:00"
|
|
9291
9409
|
}
|
|
9292
9410
|
},
|
|
9411
|
+
"x-f5xc-description-short": "VoltShare Access metric is tagged with labels mentioned in MetricLabel.",
|
|
9412
|
+
"x-f5xc-description-medium": "VoltShare Access metric is tagged with labels mentioned in MetricLabel. Metric label filter can be specified to query/aggregate specific timeseries based on label match.",
|
|
9293
9413
|
"x-f5xc-minimum-configuration": {
|
|
9294
9414
|
"description": "Minimum configuration for metricsVoltShareMetricLabelFilter",
|
|
9295
9415
|
"required_fields": [
|
|
@@ -9315,6 +9435,7 @@
|
|
|
9315
9435
|
"default": "EQ",
|
|
9316
9436
|
"x-displayname": "VoltShare Access Metric Label Operator.",
|
|
9317
9437
|
"x-ves-proto-enum": "ves.io.schema.voltshare.metrics.VoltShareMetricLabelOp",
|
|
9438
|
+
"x-f5xc-description-short": "The operator to use when querying VoltShare Access metrics with labels.",
|
|
9318
9439
|
"x-f5xc-minimum-configuration": {
|
|
9319
9440
|
"description": "Minimum configuration for metricsVoltShareMetricLabelOp",
|
|
9320
9441
|
"required_fields": [],
|
|
@@ -9364,9 +9485,10 @@
|
|
|
9364
9485
|
},
|
|
9365
9486
|
"x-original-maxLength": 1024,
|
|
9366
9487
|
"x-reconciled-from-discovery": true,
|
|
9367
|
-
"x-reconciled-at": "2026-01-
|
|
9488
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331784+00:00"
|
|
9368
9489
|
}
|
|
9369
9490
|
},
|
|
9491
|
+
"x-f5xc-description-short": "Value returned for a VoltShare Access Metrics query.",
|
|
9370
9492
|
"x-f5xc-minimum-configuration": {
|
|
9371
9493
|
"description": "Minimum configuration for metricsVoltShareMetricValue",
|
|
9372
9494
|
"required_fields": [
|
|
@@ -9391,6 +9513,7 @@
|
|
|
9391
9513
|
"default": "DESCENDING",
|
|
9392
9514
|
"x-displayname": "Sort Order.",
|
|
9393
9515
|
"x-ves-proto-enum": "ves.io.schema.SortOrder",
|
|
9516
|
+
"x-f5xc-description-short": "Sort algorithm Sort in descending order Sort in ascending order.",
|
|
9394
9517
|
"x-f5xc-minimum-configuration": {
|
|
9395
9518
|
"description": "Minimum configuration for schemaSortOrder",
|
|
9396
9519
|
"required_fields": [],
|
|
@@ -9411,6 +9534,8 @@
|
|
|
9411
9534
|
"TREND_SENTIMENT_NEGATIVE"
|
|
9412
9535
|
],
|
|
9413
9536
|
"default": "TREND_SENTIMENT_NONE",
|
|
9537
|
+
"x-f5xc-description-short": "X-displayName: \"Trend Sentiment\" trend sentiment - TREND_SENTIMENT_NONE: x-displayName: \"None\" - TREND_SENTIMENT_POSITIVE: x-displayName...",
|
|
9538
|
+
"x-f5xc-description-medium": "X-displayName: \"Trend Sentiment\" trend sentiment - TREND_SENTIMENT_NONE: x-displayName: \"None\" - TREND_SENTIMENT_POSITIVE: x-displayName: \"Positive\" Indicates trend sentiment is positive - TREND_SENTIMENT_NEGATIVE: x-displayName: \"Negative\" Indicates trend sentiment is negative.",
|
|
9414
9539
|
"x-f5xc-minimum-configuration": {
|
|
9415
9540
|
"description": "Minimum configuration for schemaTrendSentiment",
|
|
9416
9541
|
"required_fields": [],
|
|
@@ -9431,6 +9556,7 @@
|
|
|
9431
9556
|
"description": "X-displayName: \"Description\"\ndescription of the method used to calculate trend.",
|
|
9432
9557
|
"title": "Description.",
|
|
9433
9558
|
"x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval",
|
|
9559
|
+
"x-f5xc-description-short": "X-displayName: \"Description\" description of the method used to calculate trend.",
|
|
9434
9560
|
"minLength": 0,
|
|
9435
9561
|
"maxLength": 0,
|
|
9436
9562
|
"x-f5xc-required-for": {
|
|
@@ -9441,7 +9567,7 @@
|
|
|
9441
9567
|
},
|
|
9442
9568
|
"x-original-maxLength": 1024,
|
|
9443
9569
|
"x-reconciled-from-discovery": true,
|
|
9444
|
-
"x-reconciled-at": "2026-01-
|
|
9570
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331790+00:00"
|
|
9445
9571
|
},
|
|
9446
9572
|
"previous_value": {
|
|
9447
9573
|
"type": "string",
|
|
@@ -9475,9 +9601,11 @@
|
|
|
9475
9601
|
},
|
|
9476
9602
|
"x-original-maxLength": 1024,
|
|
9477
9603
|
"x-reconciled-from-discovery": true,
|
|
9478
|
-
"x-reconciled-at": "2026-01-
|
|
9604
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331797+00:00"
|
|
9479
9605
|
}
|
|
9480
9606
|
},
|
|
9607
|
+
"x-f5xc-description-short": "X-displayName: \"Trend Value\" Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
9608
|
+
"x-f5xc-description-medium": "X-displayName: \"Trend Value\" Trend value contains trend value, trend sentiment and trend calculation description and window size.",
|
|
9481
9609
|
"x-f5xc-minimum-configuration": {
|
|
9482
9610
|
"description": "Minimum configuration for schemaTrendValue",
|
|
9483
9611
|
"required_fields": [
|
|
@@ -9505,6 +9633,8 @@
|
|
|
9505
9633
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
|
|
9506
9634
|
"title": "Aggregations.",
|
|
9507
9635
|
"x-displayname": "Aggregations.",
|
|
9636
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9637
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
|
|
9508
9638
|
"x-f5xc-required-for": {
|
|
9509
9639
|
"minimum_config": false,
|
|
9510
9640
|
"create": false,
|
|
@@ -9525,6 +9655,8 @@
|
|
|
9525
9655
|
"x-validation-rules": {
|
|
9526
9656
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9527
9657
|
},
|
|
9658
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
|
|
9659
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
9528
9660
|
"minLength": 0,
|
|
9529
9661
|
"maxLength": 1024,
|
|
9530
9662
|
"x-f5xc-required-for": {
|
|
@@ -9541,6 +9673,7 @@
|
|
|
9541
9673
|
"x-displayname": "Namespace",
|
|
9542
9674
|
"x-ves-example": "Value",
|
|
9543
9675
|
"x-f5xc-example": "value",
|
|
9676
|
+
"x-f5xc-description-short": "Fetch aggregation data scoped by namespace.",
|
|
9544
9677
|
"minLength": 0,
|
|
9545
9678
|
"maxLength": 6,
|
|
9546
9679
|
"x-f5xc-required-for": {
|
|
@@ -9551,7 +9684,7 @@
|
|
|
9551
9684
|
},
|
|
9552
9685
|
"x-original-maxLength": 1024,
|
|
9553
9686
|
"x-reconciled-from-discovery": true,
|
|
9554
|
-
"x-reconciled-at": "2026-01-
|
|
9687
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331806+00:00"
|
|
9555
9688
|
},
|
|
9556
9689
|
"query": {
|
|
9557
9690
|
"type": "string",
|
|
@@ -9560,6 +9693,8 @@
|
|
|
9560
9693
|
"x-displayname": "Query",
|
|
9561
9694
|
"x-ves-example": "{user=\\\"abc@xyz.com\\\"}",
|
|
9562
9695
|
"x-f5xc-example": "\"{user=\\\"abc@xyz.com\\\"}\"",
|
|
9696
|
+
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
|
|
9697
|
+
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
|
|
9563
9698
|
"minLength": 0,
|
|
9564
9699
|
"maxLength": 1024,
|
|
9565
9700
|
"x-f5xc-required-for": {
|
|
@@ -9582,6 +9717,8 @@
|
|
|
9582
9717
|
"x-validation-rules": {
|
|
9583
9718
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9584
9719
|
},
|
|
9720
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
|
|
9721
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
9585
9722
|
"minLength": 0,
|
|
9586
9723
|
"maxLength": 1024,
|
|
9587
9724
|
"x-f5xc-required-for": {
|
|
@@ -9592,6 +9729,7 @@
|
|
|
9592
9729
|
}
|
|
9593
9730
|
}
|
|
9594
9731
|
},
|
|
9732
|
+
"x-f5xc-description-short": "Request to GET only aggregation data for audit logs.",
|
|
9595
9733
|
"x-f5xc-minimum-configuration": {
|
|
9596
9734
|
"description": "Minimum configuration for voltshareAuditLogAggregationRequest",
|
|
9597
9735
|
"required_fields": [
|
|
@@ -9620,6 +9758,8 @@
|
|
|
9620
9758
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request.",
|
|
9621
9759
|
"title": "Aggregations.",
|
|
9622
9760
|
"x-displayname": "Aggregations.",
|
|
9761
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9762
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is keyed with the aggregation name...",
|
|
9623
9763
|
"x-f5xc-required-for": {
|
|
9624
9764
|
"minimum_config": false,
|
|
9625
9765
|
"create": false,
|
|
@@ -9635,6 +9775,7 @@
|
|
|
9635
9775
|
"x-displayname": "Total Hits.",
|
|
9636
9776
|
"x-ves-example": "0",
|
|
9637
9777
|
"x-f5xc-example": "0",
|
|
9778
|
+
"x-f5xc-description-short": "Total number of log messages that matched the query.",
|
|
9638
9779
|
"minLength": 0,
|
|
9639
9780
|
"maxLength": 1024,
|
|
9640
9781
|
"x-f5xc-required-for": {
|
|
@@ -9645,6 +9786,7 @@
|
|
|
9645
9786
|
}
|
|
9646
9787
|
}
|
|
9647
9788
|
},
|
|
9789
|
+
"x-f5xc-description-short": "Response message for AuditLogAggregationRequest.",
|
|
9648
9790
|
"x-f5xc-minimum-configuration": {
|
|
9649
9791
|
"description": "Minimum configuration for voltshareAuditLogAggregationResponse",
|
|
9650
9792
|
"required_fields": [
|
|
@@ -9670,6 +9812,8 @@
|
|
|
9670
9812
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are keyed by user-defined aggregation name. The response will be keyed with the same name.\nOptional.",
|
|
9671
9813
|
"title": "Aggregations.",
|
|
9672
9814
|
"x-displayname": "Aggregations.",
|
|
9815
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9816
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are keyed by user-defined aggregation name.",
|
|
9673
9817
|
"x-f5xc-required-for": {
|
|
9674
9818
|
"minimum_config": false,
|
|
9675
9819
|
"create": false,
|
|
@@ -9690,6 +9834,8 @@
|
|
|
9690
9834
|
"x-validation-rules": {
|
|
9691
9835
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9692
9836
|
},
|
|
9837
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...",
|
|
9838
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
9693
9839
|
"minLength": 0,
|
|
9694
9840
|
"maxLength": 1024,
|
|
9695
9841
|
"x-f5xc-required-for": {
|
|
@@ -9707,6 +9853,8 @@
|
|
|
9707
9853
|
"x-displayname": "Limit",
|
|
9708
9854
|
"x-ves-example": "0",
|
|
9709
9855
|
"x-f5xc-example": "0",
|
|
9856
|
+
"x-f5xc-description-short": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on...",
|
|
9857
|
+
"x-f5xc-description-medium": "Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.",
|
|
9710
9858
|
"minimum": 0,
|
|
9711
9859
|
"maximum": 2147483647,
|
|
9712
9860
|
"x-f5xc-required-for": {
|
|
@@ -9723,6 +9871,7 @@
|
|
|
9723
9871
|
"x-displayname": "Namespace",
|
|
9724
9872
|
"x-ves-example": "Value",
|
|
9725
9873
|
"x-f5xc-example": "value",
|
|
9874
|
+
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
|
|
9726
9875
|
"minLength": 0,
|
|
9727
9876
|
"maxLength": 6,
|
|
9728
9877
|
"x-f5xc-required-for": {
|
|
@@ -9733,7 +9882,7 @@
|
|
|
9733
9882
|
},
|
|
9734
9883
|
"x-original-maxLength": 1024,
|
|
9735
9884
|
"x-reconciled-from-discovery": true,
|
|
9736
|
-
"x-reconciled-at": "2026-01-
|
|
9885
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331822+00:00"
|
|
9737
9886
|
},
|
|
9738
9887
|
"query": {
|
|
9739
9888
|
"type": "string",
|
|
@@ -9742,6 +9891,8 @@
|
|
|
9742
9891
|
"x-displayname": "Query",
|
|
9743
9892
|
"x-ves-example": "{user=\\\"abc@xyz.com\\\"}",
|
|
9744
9893
|
"x-f5xc-example": "\"{user=\\\"abc@xyz.com\\\"}\"",
|
|
9894
|
+
"x-f5xc-description-short": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> :=...",
|
|
9895
|
+
"x-f5xc-description-medium": "Query is used to specify the list of matchers syntax for query := {[<matcher>]} <matcher> := <field_name><operator>\"<value>\" <field_name> := string One or more of the following fields in audit log may be specified in the query. User - user name src_ip - source IP address secret_name - secret...",
|
|
9745
9896
|
"minLength": 0,
|
|
9746
9897
|
"maxLength": 1024,
|
|
9747
9898
|
"x-f5xc-required-for": {
|
|
@@ -9759,6 +9910,8 @@
|
|
|
9759
9910
|
"x-displayname": "Scroll",
|
|
9760
9911
|
"x-ves-example": "True",
|
|
9761
9912
|
"x-f5xc-example": "true",
|
|
9913
|
+
"x-f5xc-description-short": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.",
|
|
9914
|
+
"x-f5xc-description-medium": "Scroll is used to retrieve large number of log messages (or all log messages) that matches the query. If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next batch of logs until there are no more logs left to return. The number of messages in each...",
|
|
9762
9915
|
"x-f5xc-required-for": {
|
|
9763
9916
|
"minimum_config": false,
|
|
9764
9917
|
"create": false,
|
|
@@ -9782,6 +9935,8 @@
|
|
|
9782
9935
|
"x-validation-rules": {
|
|
9783
9936
|
"ves.io.schema.rules.string.query_time": "true"
|
|
9784
9937
|
},
|
|
9938
|
+
"x-f5xc-description-short": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated...",
|
|
9939
|
+
"x-f5xc-description-medium": "Fetch audit logs whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
9785
9940
|
"minLength": 0,
|
|
9786
9941
|
"maxLength": 1024,
|
|
9787
9942
|
"x-f5xc-required-for": {
|
|
@@ -9823,6 +9978,8 @@
|
|
|
9823
9978
|
"description": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is keyed with the aggregation name specified in the request.",
|
|
9824
9979
|
"title": "Aggregations.",
|
|
9825
9980
|
"x-displayname": "Aggregations.",
|
|
9981
|
+
"x-f5xc-description-short": "Aggregations provide summary/analytics data over the log response.",
|
|
9982
|
+
"x-f5xc-description-medium": "Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is keyed with the aggregation name...",
|
|
9826
9983
|
"x-f5xc-required-for": {
|
|
9827
9984
|
"minimum_config": false,
|
|
9828
9985
|
"create": false,
|
|
@@ -9840,6 +9997,8 @@
|
|
|
9840
9997
|
"x-displayname": "Logs",
|
|
9841
9998
|
"x-ves-example": "Value",
|
|
9842
9999
|
"x-f5xc-example": "value",
|
|
10000
|
+
"x-f5xc-description-short": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.",
|
|
10001
|
+
"x-f5xc-description-medium": "List of log messages that matched the query. Not all log messages that matched the query are returned in the response.",
|
|
9843
10002
|
"x-f5xc-required-for": {
|
|
9844
10003
|
"minimum_config": false,
|
|
9845
10004
|
"create": false,
|
|
@@ -9854,6 +10013,8 @@
|
|
|
9854
10013
|
"x-displayname": "Scroll ID",
|
|
9855
10014
|
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
9856
10015
|
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
|
|
10016
|
+
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.",
|
|
10017
|
+
"x-f5xc-description-medium": "Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF).",
|
|
9857
10018
|
"minLength": 0,
|
|
9858
10019
|
"maxLength": 1024,
|
|
9859
10020
|
"x-f5xc-required-for": {
|
|
@@ -9872,6 +10033,7 @@
|
|
|
9872
10033
|
"x-displayname": "Total Hits.",
|
|
9873
10034
|
"x-ves-example": "0",
|
|
9874
10035
|
"x-f5xc-example": "0",
|
|
10036
|
+
"x-f5xc-description-short": "Total number of log messages that matched the query.",
|
|
9875
10037
|
"minLength": 0,
|
|
9876
10038
|
"maxLength": 1024,
|
|
9877
10039
|
"x-f5xc-required-for": {
|
|
@@ -9882,6 +10044,7 @@
|
|
|
9882
10044
|
}
|
|
9883
10045
|
}
|
|
9884
10046
|
},
|
|
10047
|
+
"x-f5xc-description-short": "Response message for AuditLogRequest/LogScrollRequest.",
|
|
9885
10048
|
"x-f5xc-minimum-configuration": {
|
|
9886
10049
|
"description": "Minimum configuration for voltshareAuditLogResponse",
|
|
9887
10050
|
"required_fields": [
|
|
@@ -9911,6 +10074,7 @@
|
|
|
9911
10074
|
"x-displayname": "Namespace",
|
|
9912
10075
|
"x-ves-example": "Value",
|
|
9913
10076
|
"x-f5xc-example": "value",
|
|
10077
|
+
"x-f5xc-description-short": "Fetch the log messages scoped by namespace.",
|
|
9914
10078
|
"minLength": 0,
|
|
9915
10079
|
"maxLength": 6,
|
|
9916
10080
|
"x-f5xc-required-for": {
|
|
@@ -9921,7 +10085,7 @@
|
|
|
9921
10085
|
},
|
|
9922
10086
|
"x-original-maxLength": 1024,
|
|
9923
10087
|
"x-reconciled-from-discovery": true,
|
|
9924
|
-
"x-reconciled-at": "2026-01-
|
|
10088
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331839+00:00"
|
|
9925
10089
|
},
|
|
9926
10090
|
"scroll_id": {
|
|
9927
10091
|
"type": "string",
|
|
@@ -9930,6 +10094,7 @@
|
|
|
9930
10094
|
"x-displayname": "Scroll ID",
|
|
9931
10095
|
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
9932
10096
|
"x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==",
|
|
10097
|
+
"x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
|
|
9933
10098
|
"minLength": 0,
|
|
9934
10099
|
"maxLength": 1024,
|
|
9935
10100
|
"x-f5xc-required-for": {
|
|
@@ -9941,6 +10106,8 @@
|
|
|
9941
10106
|
"x-field-mutability": "read-only"
|
|
9942
10107
|
}
|
|
9943
10108
|
},
|
|
10109
|
+
"x-f5xc-description-short": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for...",
|
|
10110
|
+
"x-f5xc-description-medium": "Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse containing no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or all log messages, one can use the LogScrollRequest. Use the scroll_id returned...",
|
|
9944
10111
|
"x-f5xc-minimum-configuration": {
|
|
9945
10112
|
"description": "Minimum configuration for voltshareAuditLogScrollRequest",
|
|
9946
10113
|
"required_fields": [
|
|
@@ -9975,6 +10142,7 @@
|
|
|
9975
10142
|
"x-validation-rules": {
|
|
9976
10143
|
"ves.io.schema.rules.message.required": "true"
|
|
9977
10144
|
},
|
|
10145
|
+
"x-f5xc-description-short": "Blinded Encrypted Key in base64 format Required: YES.",
|
|
9978
10146
|
"minLength": 0,
|
|
9979
10147
|
"maxLength": 1024,
|
|
9980
10148
|
"x-f5xc-required-for": {
|
|
@@ -10001,6 +10169,7 @@
|
|
|
10001
10169
|
"x-validation-rules": {
|
|
10002
10170
|
"ves.io.schema.rules.message.required": "true"
|
|
10003
10171
|
},
|
|
10172
|
+
"x-f5xc-description-short": "Base64 encoded HMAC of the policy document Required: YES.",
|
|
10004
10173
|
"minLength": 0,
|
|
10005
10174
|
"maxLength": 1024,
|
|
10006
10175
|
"x-f5xc-required-for": {
|
|
@@ -10011,6 +10180,7 @@
|
|
|
10011
10180
|
}
|
|
10012
10181
|
}
|
|
10013
10182
|
},
|
|
10183
|
+
"x-f5xc-description-short": "DecryptSecretRequest contains parameters for DecryptSecret API.",
|
|
10014
10184
|
"x-f5xc-minimum-configuration": {
|
|
10015
10185
|
"description": "Minimum configuration for voltshareDecryptSecretRequest",
|
|
10016
10186
|
"required_fields": [
|
|
@@ -10049,6 +10219,7 @@
|
|
|
10049
10219
|
}
|
|
10050
10220
|
}
|
|
10051
10221
|
},
|
|
10222
|
+
"x-f5xc-description-short": "DecryptSecretResponse contains the response of DecryptSecret API.",
|
|
10052
10223
|
"x-f5xc-minimum-configuration": {
|
|
10053
10224
|
"description": "Minimum configuration for voltshareDecryptSecretResponse",
|
|
10054
10225
|
"required_fields": [
|
|
@@ -10079,6 +10250,7 @@
|
|
|
10079
10250
|
"x-displayname": "Blindfold KeyVersion.",
|
|
10080
10251
|
"x-ves-example": "0",
|
|
10081
10252
|
"x-f5xc-example": "0",
|
|
10253
|
+
"x-f5xc-description-short": "Version of BlindfoldKey that will be used for encryption.",
|
|
10082
10254
|
"minimum": 0,
|
|
10083
10255
|
"maximum": 2147483647,
|
|
10084
10256
|
"x-f5xc-required-for": {
|
|
@@ -10114,6 +10286,7 @@
|
|
|
10114
10286
|
"x-displayname": "PolicyID",
|
|
10115
10287
|
"x-ves-example": "0",
|
|
10116
10288
|
"x-f5xc-example": "0",
|
|
10289
|
+
"x-f5xc-description-short": "Unique 31 bit number assigned to this policy.",
|
|
10117
10290
|
"minLength": 0,
|
|
10118
10291
|
"maxLength": 1024,
|
|
10119
10292
|
"x-f5xc-required-for": {
|
|
@@ -10141,6 +10314,7 @@
|
|
|
10141
10314
|
}
|
|
10142
10315
|
}
|
|
10143
10316
|
},
|
|
10317
|
+
"x-f5xc-description-short": "PolicyInformation contains user defined policy and metadata added by the backend server.",
|
|
10144
10318
|
"x-f5xc-minimum-configuration": {
|
|
10145
10319
|
"description": "Minimum configuration for voltsharePolicyInformationType",
|
|
10146
10320
|
"required_fields": [
|
|
@@ -10180,6 +10354,7 @@
|
|
|
10180
10354
|
"x-validation-rules": {
|
|
10181
10355
|
"ves.io.schema.rules.repeated.max_items": "256"
|
|
10182
10356
|
},
|
|
10357
|
+
"x-f5xc-description-short": "List of Users allowed to decrypt the secret.",
|
|
10183
10358
|
"x-f5xc-required-for": {
|
|
10184
10359
|
"minimum_config": false,
|
|
10185
10360
|
"create": false,
|
|
@@ -10193,6 +10368,7 @@
|
|
|
10193
10368
|
"title": "Expiration_timestamp.",
|
|
10194
10369
|
"format": "date-time",
|
|
10195
10370
|
"x-displayname": "Expiration Time.",
|
|
10371
|
+
"x-f5xc-description-short": "Until when this policy is valid. After expiration only author can decrypt the secret.",
|
|
10196
10372
|
"minLength": 0,
|
|
10197
10373
|
"maxLength": 1024,
|
|
10198
10374
|
"x-f5xc-required-for": {
|
|
@@ -10203,6 +10379,7 @@
|
|
|
10203
10379
|
}
|
|
10204
10380
|
}
|
|
10205
10381
|
},
|
|
10382
|
+
"x-f5xc-description-short": "Policy contains user defined policy. It contains list of allowed users and expiry time.",
|
|
10206
10383
|
"x-f5xc-minimum-configuration": {
|
|
10207
10384
|
"description": "Minimum configuration for voltsharePolicyType",
|
|
10208
10385
|
"required_fields": [
|
|
@@ -10254,6 +10431,7 @@
|
|
|
10254
10431
|
}
|
|
10255
10432
|
}
|
|
10256
10433
|
},
|
|
10434
|
+
"x-f5xc-description-short": "ProcessPolicyRequest contains parameters ProcessPolicyInformation API.",
|
|
10257
10435
|
"x-f5xc-minimum-configuration": {
|
|
10258
10436
|
"description": "Minimum configuration for voltshareProcessPolicyRequest",
|
|
10259
10437
|
"required_fields": [
|
|
@@ -10284,6 +10462,7 @@
|
|
|
10284
10462
|
"x-displayname": "Policy Document HMAC.",
|
|
10285
10463
|
"x-ves-example": "Value",
|
|
10286
10464
|
"x-f5xc-example": "value",
|
|
10465
|
+
"x-f5xc-description-short": "Base64 encoded HMAC of the policy document.",
|
|
10287
10466
|
"minLength": 0,
|
|
10288
10467
|
"maxLength": 1024,
|
|
10289
10468
|
"x-f5xc-required-for": {
|
|
@@ -10300,6 +10479,8 @@
|
|
|
10300
10479
|
"x-displayname": "Public Key Document.",
|
|
10301
10480
|
"x-ves-example": "Value",
|
|
10302
10481
|
"x-f5xc-example": "value",
|
|
10482
|
+
"x-f5xc-description-short": "PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key.",
|
|
10483
|
+
"x-f5xc-description-medium": "PublicKey Document contains information about PublicKey used to encrypt symmetric encryption key. Private part of this key is ONLY with F5XC Secret Management service. Value of this field is a base64 string.",
|
|
10303
10484
|
"minLength": 0,
|
|
10304
10485
|
"maxLength": 1024,
|
|
10305
10486
|
"x-f5xc-required-for": {
|
|
@@ -10310,6 +10491,8 @@
|
|
|
10310
10491
|
}
|
|
10311
10492
|
}
|
|
10312
10493
|
},
|
|
10494
|
+
"x-f5xc-description-short": "Response of the ProcessPolicyInformation API. It contains Processed Policy, HMAC of the policy and PublicKey to be used for encryption.",
|
|
10495
|
+
"x-f5xc-description-medium": "Response of the ProcessPolicyInformation API. It contains Processed Policy, HMAC of the policy and PublicKey to be used for encryption.",
|
|
10313
10496
|
"x-f5xc-minimum-configuration": {
|
|
10314
10497
|
"description": "Minimum configuration for voltshareProcessPolicyResponse",
|
|
10315
10498
|
"required_fields": [
|
|
@@ -10385,9 +10568,10 @@
|
|
|
10385
10568
|
"x-field-mutability": "read-only",
|
|
10386
10569
|
"x-original-maxLength": 256,
|
|
10387
10570
|
"x-reconciled-from-discovery": true,
|
|
10388
|
-
"x-reconciled-at": "2026-01-
|
|
10571
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331874+00:00"
|
|
10389
10572
|
}
|
|
10390
10573
|
},
|
|
10574
|
+
"x-f5xc-description-short": "UserRecordType contains information about a user.",
|
|
10391
10575
|
"x-f5xc-minimum-configuration": {
|
|
10392
10576
|
"description": "Minimum configuration for voltshareUserRecordType",
|
|
10393
10577
|
"required_fields": [
|
|
@@ -10421,6 +10605,8 @@
|
|
|
10421
10605
|
"x-validation-rules": {
|
|
10422
10606
|
"ves.io.schema.rules.string.query_time": "true"
|
|
10423
10607
|
},
|
|
10608
|
+
"x-f5xc-description-short": "End time of metric collection from which data will be considered.",
|
|
10609
|
+
"x-f5xc-description-medium": "End time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to <current time>.",
|
|
10424
10610
|
"minLength": 0,
|
|
10425
10611
|
"maxLength": 1024,
|
|
10426
10612
|
"x-f5xc-required-for": {
|
|
@@ -10438,6 +10624,8 @@
|
|
|
10438
10624
|
"$ref": "#/components/schemas/metricsVoltShareMetricLabel"
|
|
10439
10625
|
},
|
|
10440
10626
|
"x-displayname": "Group By",
|
|
10627
|
+
"x-f5xc-description-short": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY.",
|
|
10628
|
+
"x-f5xc-description-medium": "Aggregate data by one or more labels listed here. OPERATION, RESULT, USER_TENANT, COUNTRY. Optional: If not specified, then the metric is aggregated across all the labels.",
|
|
10441
10629
|
"x-f5xc-required-for": {
|
|
10442
10630
|
"minimum_config": false,
|
|
10443
10631
|
"create": false,
|
|
@@ -10453,6 +10641,8 @@
|
|
|
10453
10641
|
"$ref": "#/components/schemas/metricsVoltShareMetricLabelFilter"
|
|
10454
10642
|
},
|
|
10455
10643
|
"x-displayname": "Label Filter.",
|
|
10644
|
+
"x-f5xc-description-short": "List of label filter expressions of the form \"label\" Op \"value\".",
|
|
10645
|
+
"x-f5xc-description-medium": "List of label filter expressions of the form \"label\" Op \"value\". Response will only contain data that matches all the conditions specified in the label_filter. One or more of the following labels can be specified in the label_filter.",
|
|
10456
10646
|
"x-f5xc-required-for": {
|
|
10457
10647
|
"minimum_config": false,
|
|
10458
10648
|
"create": false,
|
|
@@ -10467,6 +10657,7 @@
|
|
|
10467
10657
|
"x-displayname": "Namespace",
|
|
10468
10658
|
"x-ves-example": "Blogging-app-namespace-1.",
|
|
10469
10659
|
"x-f5xc-example": "blogging-app-namespace-1",
|
|
10660
|
+
"x-f5xc-description-short": "Namespace is used to scope the security events for the given namespace.",
|
|
10470
10661
|
"minLength": 0,
|
|
10471
10662
|
"maxLength": 6,
|
|
10472
10663
|
"x-f5xc-required-for": {
|
|
@@ -10477,7 +10668,7 @@
|
|
|
10477
10668
|
},
|
|
10478
10669
|
"x-original-maxLength": 1024,
|
|
10479
10670
|
"x-reconciled-from-discovery": true,
|
|
10480
|
-
"x-reconciled-at": "2026-01-
|
|
10671
|
+
"x-reconciled-at": "2026-01-07T15:53:18.331883+00:00"
|
|
10481
10672
|
},
|
|
10482
10673
|
"start_time": {
|
|
10483
10674
|
"type": "string",
|
|
@@ -10492,6 +10683,8 @@
|
|
|
10492
10683
|
"x-validation-rules": {
|
|
10493
10684
|
"ves.io.schema.rules.string.query_time": "true"
|
|
10494
10685
|
},
|
|
10686
|
+
"x-f5xc-description-short": "Start time of metric collection from which data will be considered.",
|
|
10687
|
+
"x-f5xc-description-medium": "Start time of metric collection from which data will be considered. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
10495
10688
|
"minLength": 0,
|
|
10496
10689
|
"maxLength": 1024,
|
|
10497
10690
|
"x-f5xc-required-for": {
|
|
@@ -10514,6 +10707,8 @@
|
|
|
10514
10707
|
"x-validation-rules": {
|
|
10515
10708
|
"ves.io.schema.rules.string.query_step": "true"
|
|
10516
10709
|
},
|
|
10710
|
+
"x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.",
|
|
10711
|
+
"x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.",
|
|
10517
10712
|
"minLength": 0,
|
|
10518
10713
|
"maxLength": 1024,
|
|
10519
10714
|
"x-f5xc-required-for": {
|
|
@@ -10524,6 +10719,8 @@
|
|
|
10524
10719
|
}
|
|
10525
10720
|
}
|
|
10526
10721
|
},
|
|
10722
|
+
"x-f5xc-description-short": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
|
|
10723
|
+
"x-f5xc-description-medium": "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
|
|
10527
10724
|
"x-f5xc-minimum-configuration": {
|
|
10528
10725
|
"description": "Minimum configuration for voltshareVoltShareAccessCountRequest",
|
|
10529
10726
|
"required_fields": [
|
|
@@ -10556,6 +10753,8 @@
|
|
|
10556
10753
|
"$ref": "#/components/schemas/metricsVoltShareAccessCounter"
|
|
10557
10754
|
},
|
|
10558
10755
|
"x-displayname": "VoltShare Access Count.",
|
|
10756
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10757
|
+
"x-f5xc-description-short": "List of VoltShare Access count data for each unique combination of group_by labels.",
|
|
10559
10758
|
"x-f5xc-required-for": {
|
|
10560
10759
|
"minimum_config": false,
|
|
10561
10760
|
"create": false,
|
|
@@ -10576,6 +10775,8 @@
|
|
|
10576
10775
|
"x-validation-rules": {
|
|
10577
10776
|
"ves.io.schema.rules.string.time_interval": "true"
|
|
10578
10777
|
},
|
|
10778
|
+
"x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.",
|
|
10779
|
+
"x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.",
|
|
10579
10780
|
"minLength": 0,
|
|
10580
10781
|
"maxLength": 1024,
|
|
10581
10782
|
"x-f5xc-required-for": {
|
|
@@ -10586,6 +10787,8 @@
|
|
|
10586
10787
|
}
|
|
10587
10788
|
}
|
|
10588
10789
|
},
|
|
10790
|
+
"x-f5xc-description-short": "VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.",
|
|
10791
|
+
"x-f5xc-description-medium": "VoltShare access count for each unique combination of group_by labels in the VoltShareAccessCountRequest.",
|
|
10589
10792
|
"x-f5xc-minimum-configuration": {
|
|
10590
10793
|
"description": "Minimum configuration for voltshareVoltShareAccessCountResponse",
|
|
10591
10794
|
"required_fields": [
|
|
@@ -10605,6 +10808,7 @@
|
|
|
10605
10808
|
"title": "Empty",
|
|
10606
10809
|
"x-displayname": "Empty",
|
|
10607
10810
|
"x-ves-proto-message": "ves.io.schema.Empty",
|
|
10811
|
+
"x-f5xc-description-short": "Can be used for messages where no values are needed.",
|
|
10608
10812
|
"x-f5xc-minimum-configuration": {
|
|
10609
10813
|
"description": "Minimum configuration for ioschemaEmpty",
|
|
10610
10814
|
"required_fields": [],
|
|
@@ -10622,6 +10826,8 @@
|
|
|
10622
10826
|
"type_url": {
|
|
10623
10827
|
"type": "string",
|
|
10624
10828
|
"description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.",
|
|
10829
|
+
"x-f5xc-description-short": "URL identifying the protocol buffer message type.",
|
|
10830
|
+
"x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).",
|
|
10625
10831
|
"minLength": 0,
|
|
10626
10832
|
"maxLength": 1024,
|
|
10627
10833
|
"x-f5xc-required-for": {
|
|
@@ -10645,9 +10851,11 @@
|
|
|
10645
10851
|
},
|
|
10646
10852
|
"x-original-maxLength": 1024,
|
|
10647
10853
|
"x-reconciled-from-discovery": true,
|
|
10648
|
-
"x-reconciled-at": "2026-01-
|
|
10854
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397735+00:00"
|
|
10649
10855
|
}
|
|
10650
10856
|
},
|
|
10857
|
+
"x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.",
|
|
10858
|
+
"x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...",
|
|
10651
10859
|
"x-f5xc-minimum-configuration": {
|
|
10652
10860
|
"description": "Minimum configuration for protobufAny",
|
|
10653
10861
|
"required_fields": [
|
|
@@ -10689,6 +10897,7 @@
|
|
|
10689
10897
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
10690
10898
|
}
|
|
10691
10899
|
},
|
|
10900
|
+
"x-f5xc-description-short": "AppRoleAuthInfoType contains parameters for AppRole authentication in Hashicorp Vault.",
|
|
10692
10901
|
"x-f5xc-minimum-configuration": {
|
|
10693
10902
|
"description": "Minimum configuration for schemaAppRoleAuthInfoType",
|
|
10694
10903
|
"required_fields": [
|
|
@@ -10719,6 +10928,7 @@
|
|
|
10719
10928
|
"x-displayname": "Username",
|
|
10720
10929
|
"x-ves-example": "Value",
|
|
10721
10930
|
"x-f5xc-example": "value",
|
|
10931
|
+
"x-f5xc-description-short": "The username to encode in Basic Auth scheme.",
|
|
10722
10932
|
"minLength": 0,
|
|
10723
10933
|
"maxLength": 1024,
|
|
10724
10934
|
"x-f5xc-required-for": {
|
|
@@ -10729,6 +10939,7 @@
|
|
|
10729
10939
|
}
|
|
10730
10940
|
}
|
|
10731
10941
|
},
|
|
10942
|
+
"x-f5xc-description-short": "AuthnTypeBasicAuth is used for using basic_auth mode of HTTP authentication.",
|
|
10732
10943
|
"x-f5xc-minimum-configuration": {
|
|
10733
10944
|
"description": "Minimum configuration for schemaAuthnTypeBasicAuth",
|
|
10734
10945
|
"required_fields": [
|
|
@@ -10764,6 +10975,8 @@
|
|
|
10764
10975
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
10765
10976
|
"ves.io.schema.rules.map.max_pairs": "16"
|
|
10766
10977
|
},
|
|
10978
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
10979
|
+
"x-f5xc-description-short": "The set of authentication headers to pass in HTTP request.",
|
|
10767
10980
|
"x-f5xc-required-for": {
|
|
10768
10981
|
"minimum_config": false,
|
|
10769
10982
|
"create": false,
|
|
@@ -10772,6 +10985,7 @@
|
|
|
10772
10985
|
}
|
|
10773
10986
|
}
|
|
10774
10987
|
},
|
|
10988
|
+
"x-f5xc-description-short": "AuthnTypeHeaders is used for setting headers for authentication.",
|
|
10775
10989
|
"x-f5xc-minimum-configuration": {
|
|
10776
10990
|
"description": "Minimum configuration for schemaAuthnTypeHeaders",
|
|
10777
10991
|
"required_fields": [
|
|
@@ -10806,6 +11020,7 @@
|
|
|
10806
11020
|
"ves.io.schema.rules.map.keys.string.min_len": "1",
|
|
10807
11021
|
"ves.io.schema.rules.map.max_pairs": "16"
|
|
10808
11022
|
},
|
|
11023
|
+
"x-f5xc-description-short": "The set of authentication parameters to be passed as query parameters.",
|
|
10809
11024
|
"x-f5xc-required-for": {
|
|
10810
11025
|
"minimum_config": false,
|
|
10811
11026
|
"create": false,
|
|
@@ -10814,6 +11029,7 @@
|
|
|
10814
11029
|
}
|
|
10815
11030
|
}
|
|
10816
11031
|
},
|
|
11032
|
+
"x-f5xc-description-short": "AuthnTypeQueryParams is used for setting query_params for authentication.",
|
|
10817
11033
|
"x-f5xc-minimum-configuration": {
|
|
10818
11034
|
"description": "Minimum configuration for schemaAuthnTypeQueryParams",
|
|
10819
11035
|
"required_fields": [
|
|
@@ -10841,6 +11057,8 @@
|
|
|
10841
11057
|
"x-displayname": "Decryption Provider.",
|
|
10842
11058
|
"x-ves-example": "Value",
|
|
10843
11059
|
"x-f5xc-example": "value",
|
|
11060
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
11061
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.",
|
|
10844
11062
|
"minLength": 0,
|
|
10845
11063
|
"maxLength": 1024,
|
|
10846
11064
|
"x-f5xc-required-for": {
|
|
@@ -10866,6 +11084,8 @@
|
|
|
10866
11084
|
"ves.io.schema.rules.message.required": "true",
|
|
10867
11085
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
10868
11086
|
},
|
|
11087
|
+
"x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
11088
|
+
"x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.",
|
|
10869
11089
|
"minLength": 0,
|
|
10870
11090
|
"maxLength": 4,
|
|
10871
11091
|
"x-f5xc-required-for": {
|
|
@@ -10876,7 +11096,7 @@
|
|
|
10876
11096
|
},
|
|
10877
11097
|
"x-original-maxLength": 1024,
|
|
10878
11098
|
"x-reconciled-from-discovery": true,
|
|
10879
|
-
"x-reconciled-at": "2026-01-
|
|
11099
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397757+00:00"
|
|
10880
11100
|
},
|
|
10881
11101
|
"store_provider": {
|
|
10882
11102
|
"type": "string",
|
|
@@ -10885,6 +11105,8 @@
|
|
|
10885
11105
|
"x-displayname": "Store Provider.",
|
|
10886
11106
|
"x-ves-example": "Value",
|
|
10887
11107
|
"x-f5xc-example": "value",
|
|
11108
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
11109
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
10888
11110
|
"minLength": 0,
|
|
10889
11111
|
"maxLength": 1024,
|
|
10890
11112
|
"x-f5xc-required-for": {
|
|
@@ -10895,6 +11117,7 @@
|
|
|
10895
11117
|
}
|
|
10896
11118
|
}
|
|
10897
11119
|
},
|
|
11120
|
+
"x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.",
|
|
10898
11121
|
"x-f5xc-minimum-configuration": {
|
|
10899
11122
|
"description": "Minimum configuration for schemaBlindfoldSecretInfoType",
|
|
10900
11123
|
"required_fields": [
|
|
@@ -10924,6 +11147,8 @@
|
|
|
10924
11147
|
"x-displayname": "Provider",
|
|
10925
11148
|
"x-ves-example": "Box-provider.",
|
|
10926
11149
|
"x-f5xc-example": "box-provider",
|
|
11150
|
+
"x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...",
|
|
11151
|
+
"x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.",
|
|
10927
11152
|
"minLength": 0,
|
|
10928
11153
|
"maxLength": 8,
|
|
10929
11154
|
"x-f5xc-required-for": {
|
|
@@ -10934,7 +11159,7 @@
|
|
|
10934
11159
|
},
|
|
10935
11160
|
"x-original-maxLength": 1024,
|
|
10936
11161
|
"x-reconciled-from-discovery": true,
|
|
10937
|
-
"x-reconciled-at": "2026-01-
|
|
11162
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397765+00:00"
|
|
10938
11163
|
},
|
|
10939
11164
|
"url": {
|
|
10940
11165
|
"type": "string",
|
|
@@ -10955,6 +11180,8 @@
|
|
|
10955
11180
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
10956
11181
|
"ves.io.schema.rules.string.uri_ref": "true"
|
|
10957
11182
|
},
|
|
11183
|
+
"x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.",
|
|
11184
|
+
"x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.",
|
|
10958
11185
|
"format": "uri",
|
|
10959
11186
|
"minLength": 0,
|
|
10960
11187
|
"x-f5xc-required-for": {
|
|
@@ -10965,6 +11192,7 @@
|
|
|
10965
11192
|
}
|
|
10966
11193
|
}
|
|
10967
11194
|
},
|
|
11195
|
+
"x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.",
|
|
10968
11196
|
"x-f5xc-minimum-configuration": {
|
|
10969
11197
|
"description": "Minimum configuration for schemaClearSecretInfoType",
|
|
10970
11198
|
"required_fields": [
|
|
@@ -10990,6 +11218,8 @@
|
|
|
10990
11218
|
"description": "Hostname of the instance of the site that sent the status.",
|
|
10991
11219
|
"title": "Hostname",
|
|
10992
11220
|
"x-displayname": "Hostname",
|
|
11221
|
+
"x-f5xc-example": "example-resource",
|
|
11222
|
+
"x-f5xc-description-short": "Hostname of the instance of the site that sent the status.",
|
|
10993
11223
|
"minLength": 0,
|
|
10994
11224
|
"maxLength": 1024,
|
|
10995
11225
|
"x-f5xc-required-for": {
|
|
@@ -11021,6 +11251,8 @@
|
|
|
11021
11251
|
"x-displayname": "Reason",
|
|
11022
11252
|
"x-ves-example": "Value",
|
|
11023
11253
|
"x-f5xc-example": "value",
|
|
11254
|
+
"x-f5xc-description-short": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
11255
|
+
"x-f5xc-description-medium": "X-reason: \"Insufficient memory in data plane\" A human readable string explaining the reason for reaching this condition.",
|
|
11024
11256
|
"minLength": 0,
|
|
11025
11257
|
"maxLength": 43,
|
|
11026
11258
|
"x-f5xc-required-for": {
|
|
@@ -11031,13 +11263,15 @@
|
|
|
11031
11263
|
},
|
|
11032
11264
|
"x-original-maxLength": 1024,
|
|
11033
11265
|
"x-reconciled-from-discovery": true,
|
|
11034
|
-
"x-reconciled-at": "2026-01-
|
|
11266
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397776+00:00"
|
|
11035
11267
|
},
|
|
11036
11268
|
"service_name": {
|
|
11037
11269
|
"type": "string",
|
|
11038
11270
|
"description": "Name of the service that sent the status.",
|
|
11039
11271
|
"title": "Service name.",
|
|
11040
11272
|
"x-displayname": "Service Name.",
|
|
11273
|
+
"x-f5xc-example": "example-resource",
|
|
11274
|
+
"x-f5xc-description-short": "Name of the service that sent the status.",
|
|
11041
11275
|
"minLength": 0,
|
|
11042
11276
|
"maxLength": 1024,
|
|
11043
11277
|
"x-f5xc-required-for": {
|
|
@@ -11060,6 +11294,8 @@
|
|
|
11060
11294
|
"x-validation-rules": {
|
|
11061
11295
|
"ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"
|
|
11062
11296
|
},
|
|
11297
|
+
"x-f5xc-description-short": "Status of the condition \"Success\" Validtion has succeded.",
|
|
11298
|
+
"x-f5xc-description-medium": "Status of the condition \"Success\" Validtion has succeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...",
|
|
11063
11299
|
"minLength": 0,
|
|
11064
11300
|
"maxLength": 17,
|
|
11065
11301
|
"x-f5xc-required-for": {
|
|
@@ -11070,7 +11306,7 @@
|
|
|
11070
11306
|
},
|
|
11071
11307
|
"x-original-maxLength": 1024,
|
|
11072
11308
|
"x-reconciled-from-discovery": true,
|
|
11073
|
-
"x-reconciled-at": "2026-01-
|
|
11309
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397782+00:00"
|
|
11074
11310
|
},
|
|
11075
11311
|
"type": {
|
|
11076
11312
|
"type": "string",
|
|
@@ -11085,6 +11321,8 @@
|
|
|
11085
11321
|
"x-validation-rules": {
|
|
11086
11322
|
"ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]"
|
|
11087
11323
|
},
|
|
11324
|
+
"x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...",
|
|
11325
|
+
"x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.",
|
|
11088
11326
|
"minLength": 0,
|
|
11089
11327
|
"maxLength": 1024,
|
|
11090
11328
|
"x-f5xc-required-for": {
|
|
@@ -11095,6 +11333,8 @@
|
|
|
11095
11333
|
}
|
|
11096
11334
|
}
|
|
11097
11335
|
},
|
|
11336
|
+
"x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.",
|
|
11337
|
+
"x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.",
|
|
11098
11338
|
"x-f5xc-minimum-configuration": {
|
|
11099
11339
|
"description": "Minimum configuration for schemaConditionType",
|
|
11100
11340
|
"required_fields": [
|
|
@@ -11130,6 +11370,8 @@
|
|
|
11130
11370
|
"default": "EOK",
|
|
11131
11371
|
"x-displayname": "Error Code.",
|
|
11132
11372
|
"x-ves-proto-enum": "ves.io.schema.ErrorCode",
|
|
11373
|
+
"x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...",
|
|
11374
|
+
"x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...",
|
|
11133
11375
|
"x-f5xc-minimum-configuration": {
|
|
11134
11376
|
"description": "Minimum configuration for schemaErrorCode",
|
|
11135
11377
|
"required_fields": [],
|
|
@@ -11170,6 +11412,7 @@
|
|
|
11170
11412
|
}
|
|
11171
11413
|
}
|
|
11172
11414
|
},
|
|
11415
|
+
"x-f5xc-description-short": "Information about a error in API operation.",
|
|
11173
11416
|
"x-f5xc-minimum-configuration": {
|
|
11174
11417
|
"description": "Minimum configuration for schemaErrorType",
|
|
11175
11418
|
"required_fields": [
|
|
@@ -11196,6 +11439,8 @@
|
|
|
11196
11439
|
"default": "INVALID_HASH_ALGORITHM",
|
|
11197
11440
|
"x-displayname": "Hash Algorithm.",
|
|
11198
11441
|
"x-ves-proto-enum": "ves.io.schema.HashAlgorithm",
|
|
11442
|
+
"x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
11443
|
+
"x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.",
|
|
11199
11444
|
"x-f5xc-minimum-configuration": {
|
|
11200
11445
|
"description": "Minimum configuration for schemaHashAlgorithm",
|
|
11201
11446
|
"required_fields": [],
|
|
@@ -11236,6 +11481,7 @@
|
|
|
11236
11481
|
"ves.io.schema.rules.repeated.min_items": "1",
|
|
11237
11482
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
11238
11483
|
},
|
|
11484
|
+
"x-f5xc-description-short": "Ordered list of hash algorithms to be used. Required: YES.",
|
|
11239
11485
|
"x-f5xc-required-for": {
|
|
11240
11486
|
"minimum_config": false,
|
|
11241
11487
|
"create": false,
|
|
@@ -11244,6 +11490,7 @@
|
|
|
11244
11490
|
}
|
|
11245
11491
|
}
|
|
11246
11492
|
},
|
|
11493
|
+
"x-f5xc-description-short": "Specifies the hash algorithms to be used.",
|
|
11247
11494
|
"x-f5xc-minimum-configuration": {
|
|
11248
11495
|
"description": "Minimum configuration for schemaHashAlgorithms",
|
|
11249
11496
|
"required_fields": [
|
|
@@ -11290,6 +11537,7 @@
|
|
|
11290
11537
|
"ves.io.schema.rules.string.max_len": "256",
|
|
11291
11538
|
"ves.io.schema.rules.string.min_len": "1"
|
|
11292
11539
|
},
|
|
11540
|
+
"x-f5xc-description-short": "Endpoint to connect to, in host:port format Required: YES.",
|
|
11293
11541
|
"x-f5xc-required-for": {
|
|
11294
11542
|
"minimum_config": false,
|
|
11295
11543
|
"create": false,
|
|
@@ -11304,6 +11552,7 @@
|
|
|
11304
11552
|
"$ref": "#/components/schemas/schemaVaultAuthInfoType"
|
|
11305
11553
|
}
|
|
11306
11554
|
},
|
|
11555
|
+
"x-f5xc-description-short": "HostAccessInfoType contains the information about how to connect to the remote host.",
|
|
11307
11556
|
"x-f5xc-minimum-configuration": {
|
|
11308
11557
|
"description": "Minimum configuration for schemaHostAccessInfoType",
|
|
11309
11558
|
"required_fields": [
|
|
@@ -11333,6 +11582,7 @@
|
|
|
11333
11582
|
"title": "Name",
|
|
11334
11583
|
"x-displayname": "Name",
|
|
11335
11584
|
"x-f5xc-example": "example-resource",
|
|
11585
|
+
"x-f5xc-description-short": "Name of the service that is responsible for initializing this object.",
|
|
11336
11586
|
"minLength": 0,
|
|
11337
11587
|
"maxLength": 16,
|
|
11338
11588
|
"x-f5xc-required-for": {
|
|
@@ -11343,9 +11593,10 @@
|
|
|
11343
11593
|
},
|
|
11344
11594
|
"x-original-maxLength": 1024,
|
|
11345
11595
|
"x-reconciled-from-discovery": true,
|
|
11346
|
-
"x-reconciled-at": "2026-01-
|
|
11596
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397803+00:00"
|
|
11347
11597
|
}
|
|
11348
11598
|
},
|
|
11599
|
+
"x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.",
|
|
11349
11600
|
"x-f5xc-minimum-configuration": {
|
|
11350
11601
|
"description": "Minimum configuration for schemaInitializerType",
|
|
11351
11602
|
"required_fields": [
|
|
@@ -11373,6 +11624,8 @@
|
|
|
11373
11624
|
"$ref": "#/components/schemas/schemaInitializerType"
|
|
11374
11625
|
},
|
|
11375
11626
|
"x-displayname": "Pending",
|
|
11627
|
+
"x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.",
|
|
11628
|
+
"x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.",
|
|
11376
11629
|
"x-f5xc-required-for": {
|
|
11377
11630
|
"minimum_config": false,
|
|
11378
11631
|
"create": false,
|
|
@@ -11384,6 +11637,7 @@
|
|
|
11384
11637
|
"$ref": "#/components/schemas/schemaStatusType"
|
|
11385
11638
|
}
|
|
11386
11639
|
},
|
|
11640
|
+
"x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.",
|
|
11387
11641
|
"x-f5xc-minimum-configuration": {
|
|
11388
11642
|
"description": "Minimum configuration for schemaInitializersType",
|
|
11389
11643
|
"required_fields": [
|
|
@@ -11422,6 +11676,7 @@
|
|
|
11422
11676
|
"ves.io.schema.rules.message.required": "true",
|
|
11423
11677
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
11424
11678
|
},
|
|
11679
|
+
"x-f5xc-description-short": "Virtual network direct reference Required: YES.",
|
|
11425
11680
|
"x-f5xc-required-for": {
|
|
11426
11681
|
"minimum_config": false,
|
|
11427
11682
|
"create": false,
|
|
@@ -11430,6 +11685,7 @@
|
|
|
11430
11685
|
}
|
|
11431
11686
|
}
|
|
11432
11687
|
},
|
|
11688
|
+
"x-f5xc-description-short": "Specifies a direct reference to a network configuration object.",
|
|
11433
11689
|
"x-f5xc-minimum-configuration": {
|
|
11434
11690
|
"description": "Minimum configuration for schemaNetworkRefType",
|
|
11435
11691
|
"required_fields": [
|
|
@@ -11460,6 +11716,8 @@
|
|
|
11460
11716
|
"$ref": "#/components/schemas/schemaVSiteRefType"
|
|
11461
11717
|
}
|
|
11462
11718
|
},
|
|
11719
|
+
"x-f5xc-description-short": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine...",
|
|
11720
|
+
"x-f5xc-description-medium": "NetworkSiteRefSelector defines a union of reference to site or reference to virtual_network or reference to virtual_site It is used to determine virtual network using following rules * Direct reference to virtual_network object * Site local network when refering to site object * All site local...",
|
|
11463
11721
|
"x-f5xc-minimum-configuration": {
|
|
11464
11722
|
"description": "Minimum configuration for schemaNetworkSiteRefSelector",
|
|
11465
11723
|
"required_fields": [
|
|
@@ -11499,6 +11757,8 @@
|
|
|
11499
11757
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11500
11758
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11501
11759
|
},
|
|
11760
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
11761
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11502
11762
|
"x-f5xc-required-for": {
|
|
11503
11763
|
"minimum_config": false,
|
|
11504
11764
|
"create": false,
|
|
@@ -11520,6 +11780,7 @@
|
|
|
11520
11780
|
"x-validation-rules": {
|
|
11521
11781
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11522
11782
|
},
|
|
11783
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11523
11784
|
"minLength": 0,
|
|
11524
11785
|
"x-f5xc-required-for": {
|
|
11525
11786
|
"minimum_config": false,
|
|
@@ -11529,7 +11790,7 @@
|
|
|
11529
11790
|
},
|
|
11530
11791
|
"x-original-maxLength": 1200,
|
|
11531
11792
|
"x-reconciled-from-discovery": true,
|
|
11532
|
-
"x-reconciled-at": "2026-01-
|
|
11793
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397819+00:00"
|
|
11533
11794
|
},
|
|
11534
11795
|
"disable": {
|
|
11535
11796
|
"type": "boolean",
|
|
@@ -11538,6 +11799,7 @@
|
|
|
11538
11799
|
"format": "boolean",
|
|
11539
11800
|
"x-displayname": "Disable",
|
|
11540
11801
|
"x-f5xc-example": "true",
|
|
11802
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11541
11803
|
"x-f5xc-required-for": {
|
|
11542
11804
|
"minimum_config": false,
|
|
11543
11805
|
"create": false,
|
|
@@ -11551,6 +11813,8 @@
|
|
|
11551
11813
|
"title": "Labels",
|
|
11552
11814
|
"x-displayname": "Labels",
|
|
11553
11815
|
"x-f5xc-example": "value",
|
|
11816
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
11817
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11554
11818
|
"x-f5xc-required-for": {
|
|
11555
11819
|
"minimum_config": false,
|
|
11556
11820
|
"create": false,
|
|
@@ -11572,6 +11836,8 @@
|
|
|
11572
11836
|
"x-validation-rules": {
|
|
11573
11837
|
"ves.io.schema.rules.message.required": "true"
|
|
11574
11838
|
},
|
|
11839
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
11840
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11575
11841
|
"minLength": 0,
|
|
11576
11842
|
"maxLength": 16,
|
|
11577
11843
|
"x-f5xc-required-for": {
|
|
@@ -11582,7 +11848,7 @@
|
|
|
11582
11848
|
},
|
|
11583
11849
|
"x-original-maxLength": 1024,
|
|
11584
11850
|
"x-reconciled-from-discovery": true,
|
|
11585
|
-
"x-reconciled-at": "2026-01-
|
|
11851
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397827+00:00"
|
|
11586
11852
|
},
|
|
11587
11853
|
"namespace": {
|
|
11588
11854
|
"type": "string",
|
|
@@ -11591,6 +11857,8 @@
|
|
|
11591
11857
|
"x-displayname": "Namespace",
|
|
11592
11858
|
"x-ves-example": "Staging",
|
|
11593
11859
|
"x-f5xc-example": "staging",
|
|
11860
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
11861
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
11594
11862
|
"minLength": 0,
|
|
11595
11863
|
"maxLength": 6,
|
|
11596
11864
|
"x-f5xc-required-for": {
|
|
@@ -11601,9 +11869,10 @@
|
|
|
11601
11869
|
},
|
|
11602
11870
|
"x-original-maxLength": 1024,
|
|
11603
11871
|
"x-reconciled-from-discovery": true,
|
|
11604
|
-
"x-reconciled-at": "2026-01-
|
|
11872
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397831+00:00"
|
|
11605
11873
|
}
|
|
11606
11874
|
},
|
|
11875
|
+
"x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.",
|
|
11607
11876
|
"x-f5xc-minimum-configuration": {
|
|
11608
11877
|
"description": "Minimum configuration for schemaObjectCreateMetaType",
|
|
11609
11878
|
"required_fields": [
|
|
@@ -11647,6 +11916,8 @@
|
|
|
11647
11916
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11648
11917
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11649
11918
|
},
|
|
11919
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
11920
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11650
11921
|
"x-f5xc-required-for": {
|
|
11651
11922
|
"minimum_config": false,
|
|
11652
11923
|
"create": false,
|
|
@@ -11668,6 +11939,7 @@
|
|
|
11668
11939
|
"x-validation-rules": {
|
|
11669
11940
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11670
11941
|
},
|
|
11942
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11671
11943
|
"minLength": 0,
|
|
11672
11944
|
"x-f5xc-required-for": {
|
|
11673
11945
|
"minimum_config": false,
|
|
@@ -11677,7 +11949,7 @@
|
|
|
11677
11949
|
},
|
|
11678
11950
|
"x-original-maxLength": 1200,
|
|
11679
11951
|
"x-reconciled-from-discovery": true,
|
|
11680
|
-
"x-reconciled-at": "2026-01-
|
|
11952
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397838+00:00"
|
|
11681
11953
|
},
|
|
11682
11954
|
"disable": {
|
|
11683
11955
|
"type": "boolean",
|
|
@@ -11687,6 +11959,7 @@
|
|
|
11687
11959
|
"x-displayname": "Disable",
|
|
11688
11960
|
"x-ves-example": "True",
|
|
11689
11961
|
"x-f5xc-example": "true",
|
|
11962
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11690
11963
|
"x-f5xc-required-for": {
|
|
11691
11964
|
"minimum_config": false,
|
|
11692
11965
|
"create": false,
|
|
@@ -11701,6 +11974,8 @@
|
|
|
11701
11974
|
"x-displayname": "Labels",
|
|
11702
11975
|
"x-ves-example": "Value",
|
|
11703
11976
|
"x-f5xc-example": "value",
|
|
11977
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
11978
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11704
11979
|
"x-f5xc-required-for": {
|
|
11705
11980
|
"minimum_config": false,
|
|
11706
11981
|
"create": false,
|
|
@@ -11722,6 +11997,8 @@
|
|
|
11722
11997
|
"x-validation-rules": {
|
|
11723
11998
|
"ves.io.schema.rules.message.required": "true"
|
|
11724
11999
|
},
|
|
12000
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
12001
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11725
12002
|
"minLength": 0,
|
|
11726
12003
|
"maxLength": 16,
|
|
11727
12004
|
"x-f5xc-required-for": {
|
|
@@ -11732,7 +12009,7 @@
|
|
|
11732
12009
|
},
|
|
11733
12010
|
"x-original-maxLength": 1024,
|
|
11734
12011
|
"x-reconciled-from-discovery": true,
|
|
11735
|
-
"x-reconciled-at": "2026-01-
|
|
12012
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397845+00:00"
|
|
11736
12013
|
},
|
|
11737
12014
|
"namespace": {
|
|
11738
12015
|
"type": "string",
|
|
@@ -11741,6 +12018,8 @@
|
|
|
11741
12018
|
"x-displayname": "Namespace",
|
|
11742
12019
|
"x-ves-example": "Staging",
|
|
11743
12020
|
"x-f5xc-example": "staging",
|
|
12021
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
12022
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
11744
12023
|
"minLength": 0,
|
|
11745
12024
|
"maxLength": 6,
|
|
11746
12025
|
"x-f5xc-required-for": {
|
|
@@ -11751,9 +12030,10 @@
|
|
|
11751
12030
|
},
|
|
11752
12031
|
"x-original-maxLength": 1024,
|
|
11753
12032
|
"x-reconciled-from-discovery": true,
|
|
11754
|
-
"x-reconciled-at": "2026-01-
|
|
12033
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397849+00:00"
|
|
11755
12034
|
}
|
|
11756
12035
|
},
|
|
12036
|
+
"x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.",
|
|
11757
12037
|
"x-f5xc-minimum-configuration": {
|
|
11758
12038
|
"description": "Minimum configuration for schemaObjectGetMetaType",
|
|
11759
12039
|
"required_fields": [
|
|
@@ -11785,6 +12065,8 @@
|
|
|
11785
12065
|
"x-displayname": "Kind",
|
|
11786
12066
|
"x-ves-example": "Virtual_site.",
|
|
11787
12067
|
"x-f5xc-example": "virtual_site",
|
|
12068
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
12069
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
11788
12070
|
"minLength": 0,
|
|
11789
12071
|
"maxLength": 14,
|
|
11790
12072
|
"x-f5xc-required-for": {
|
|
@@ -11796,7 +12078,7 @@
|
|
|
11796
12078
|
"readOnly": true,
|
|
11797
12079
|
"x-original-maxLength": 1024,
|
|
11798
12080
|
"x-reconciled-from-discovery": true,
|
|
11799
|
-
"x-reconciled-at": "2026-01-
|
|
12081
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397854+00:00"
|
|
11800
12082
|
},
|
|
11801
12083
|
"name": {
|
|
11802
12084
|
"type": "string",
|
|
@@ -11805,6 +12087,8 @@
|
|
|
11805
12087
|
"x-displayname": "Name",
|
|
11806
12088
|
"x-ves-example": "Contactus-route.",
|
|
11807
12089
|
"x-f5xc-example": "contactus-route",
|
|
12090
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
12091
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
11808
12092
|
"minLength": 0,
|
|
11809
12093
|
"maxLength": 16,
|
|
11810
12094
|
"x-f5xc-required-for": {
|
|
@@ -11815,7 +12099,7 @@
|
|
|
11815
12099
|
},
|
|
11816
12100
|
"x-original-maxLength": 1024,
|
|
11817
12101
|
"x-reconciled-from-discovery": true,
|
|
11818
|
-
"x-reconciled-at": "2026-01-
|
|
12102
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397858+00:00"
|
|
11819
12103
|
},
|
|
11820
12104
|
"namespace": {
|
|
11821
12105
|
"type": "string",
|
|
@@ -11824,6 +12108,8 @@
|
|
|
11824
12108
|
"x-displayname": "Namespace",
|
|
11825
12109
|
"x-ves-example": "Ns1",
|
|
11826
12110
|
"x-f5xc-example": "ns1",
|
|
12111
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
12112
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
11827
12113
|
"minLength": 0,
|
|
11828
12114
|
"maxLength": 6,
|
|
11829
12115
|
"x-f5xc-required-for": {
|
|
@@ -11834,7 +12120,7 @@
|
|
|
11834
12120
|
},
|
|
11835
12121
|
"x-original-maxLength": 1024,
|
|
11836
12122
|
"x-reconciled-from-discovery": true,
|
|
11837
|
-
"x-reconciled-at": "2026-01-
|
|
12123
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397862+00:00"
|
|
11838
12124
|
},
|
|
11839
12125
|
"tenant": {
|
|
11840
12126
|
"type": "string",
|
|
@@ -11843,6 +12129,8 @@
|
|
|
11843
12129
|
"x-displayname": "Tenant",
|
|
11844
12130
|
"x-ves-example": "Example-corp.",
|
|
11845
12131
|
"x-f5xc-example": "example-corp",
|
|
12132
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
12133
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
11846
12134
|
"minLength": 0,
|
|
11847
12135
|
"maxLength": 18,
|
|
11848
12136
|
"x-f5xc-required-for": {
|
|
@@ -11855,7 +12143,7 @@
|
|
|
11855
12143
|
"x-field-mutability": "read-only",
|
|
11856
12144
|
"x-original-maxLength": 1024,
|
|
11857
12145
|
"x-reconciled-from-discovery": true,
|
|
11858
|
-
"x-reconciled-at": "2026-01-
|
|
12146
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397866+00:00"
|
|
11859
12147
|
},
|
|
11860
12148
|
"uid": {
|
|
11861
12149
|
"type": "string",
|
|
@@ -11864,6 +12152,8 @@
|
|
|
11864
12152
|
"x-displayname": "UID",
|
|
11865
12153
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
11866
12154
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12155
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
12156
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
11867
12157
|
"minLength": 0,
|
|
11868
12158
|
"maxLength": 36,
|
|
11869
12159
|
"x-f5xc-required-for": {
|
|
@@ -11877,9 +12167,11 @@
|
|
|
11877
12167
|
"x-original-maxLength": 1024,
|
|
11878
12168
|
"format": "uuid",
|
|
11879
12169
|
"x-reconciled-from-discovery": true,
|
|
11880
|
-
"x-reconciled-at": "2026-01-
|
|
12170
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397872+00:00"
|
|
11881
12171
|
}
|
|
11882
12172
|
},
|
|
12173
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
12174
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
11883
12175
|
"x-f5xc-minimum-configuration": {
|
|
11884
12176
|
"description": "Minimum configuration for schemaObjectRefType",
|
|
11885
12177
|
"required_fields": [
|
|
@@ -11922,6 +12214,8 @@
|
|
|
11922
12214
|
"ves.io.schema.rules.map.values.string.max_len": "1024",
|
|
11923
12215
|
"ves.io.schema.rules.map.values.string.min_len": "1"
|
|
11924
12216
|
},
|
|
12217
|
+
"x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.",
|
|
12218
|
+
"x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.",
|
|
11925
12219
|
"x-f5xc-required-for": {
|
|
11926
12220
|
"minimum_config": false,
|
|
11927
12221
|
"create": false,
|
|
@@ -11943,6 +12237,7 @@
|
|
|
11943
12237
|
"x-validation-rules": {
|
|
11944
12238
|
"ves.io.schema.rules.string.max_bytes": "1200"
|
|
11945
12239
|
},
|
|
12240
|
+
"x-f5xc-description-short": "Human readable description for the object.",
|
|
11946
12241
|
"minLength": 0,
|
|
11947
12242
|
"x-f5xc-required-for": {
|
|
11948
12243
|
"minimum_config": false,
|
|
@@ -11952,7 +12247,7 @@
|
|
|
11952
12247
|
},
|
|
11953
12248
|
"x-original-maxLength": 1200,
|
|
11954
12249
|
"x-reconciled-from-discovery": true,
|
|
11955
|
-
"x-reconciled-at": "2026-01-
|
|
12250
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397879+00:00"
|
|
11956
12251
|
},
|
|
11957
12252
|
"disable": {
|
|
11958
12253
|
"type": "boolean",
|
|
@@ -11961,6 +12256,7 @@
|
|
|
11961
12256
|
"format": "boolean",
|
|
11962
12257
|
"x-displayname": "Disable",
|
|
11963
12258
|
"x-f5xc-example": "true",
|
|
12259
|
+
"x-f5xc-description-short": "Value of true will administratively disable the object.",
|
|
11964
12260
|
"x-f5xc-required-for": {
|
|
11965
12261
|
"minimum_config": false,
|
|
11966
12262
|
"create": false,
|
|
@@ -11975,6 +12271,8 @@
|
|
|
11975
12271
|
"x-displayname": "Labels",
|
|
11976
12272
|
"x-ves-example": "Value",
|
|
11977
12273
|
"x-f5xc-example": "value",
|
|
12274
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.",
|
|
12275
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.",
|
|
11978
12276
|
"x-f5xc-required-for": {
|
|
11979
12277
|
"minimum_config": false,
|
|
11980
12278
|
"create": false,
|
|
@@ -11995,6 +12293,8 @@
|
|
|
11995
12293
|
"x-validation-rules": {
|
|
11996
12294
|
"ves.io.schema.rules.message.required": "true"
|
|
11997
12295
|
},
|
|
12296
|
+
"x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.",
|
|
12297
|
+
"x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.",
|
|
11998
12298
|
"minLength": 0,
|
|
11999
12299
|
"maxLength": 16,
|
|
12000
12300
|
"x-f5xc-required-for": {
|
|
@@ -12005,7 +12305,7 @@
|
|
|
12005
12305
|
},
|
|
12006
12306
|
"x-original-maxLength": 1024,
|
|
12007
12307
|
"x-reconciled-from-discovery": true,
|
|
12008
|
-
"x-reconciled-at": "2026-01-
|
|
12308
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397887+00:00"
|
|
12009
12309
|
},
|
|
12010
12310
|
"namespace": {
|
|
12011
12311
|
"type": "string",
|
|
@@ -12014,6 +12314,8 @@
|
|
|
12014
12314
|
"x-displayname": "Namespace",
|
|
12015
12315
|
"x-ves-example": "Staging",
|
|
12016
12316
|
"x-f5xc-example": "staging",
|
|
12317
|
+
"x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.",
|
|
12318
|
+
"x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".",
|
|
12017
12319
|
"minLength": 0,
|
|
12018
12320
|
"maxLength": 6,
|
|
12019
12321
|
"x-f5xc-required-for": {
|
|
@@ -12024,9 +12326,10 @@
|
|
|
12024
12326
|
},
|
|
12025
12327
|
"x-original-maxLength": 1024,
|
|
12026
12328
|
"x-reconciled-from-discovery": true,
|
|
12027
|
-
"x-reconciled-at": "2026-01-
|
|
12329
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397891+00:00"
|
|
12028
12330
|
}
|
|
12029
12331
|
},
|
|
12332
|
+
"x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.",
|
|
12030
12333
|
"x-f5xc-minimum-configuration": {
|
|
12031
12334
|
"description": "Minimum configuration for schemaObjectReplaceMetaType",
|
|
12032
12335
|
"required_fields": [
|
|
@@ -12062,6 +12365,7 @@
|
|
|
12062
12365
|
"$ref": "#/components/schemas/schemaAuthnTypeQueryParams"
|
|
12063
12366
|
}
|
|
12064
12367
|
},
|
|
12368
|
+
"x-f5xc-description-short": "Authentication parameters for REST based hosts.",
|
|
12065
12369
|
"x-f5xc-minimum-configuration": {
|
|
12066
12370
|
"description": "Minimum configuration for schemaRestAuthInfoType",
|
|
12067
12371
|
"required_fields": [
|
|
@@ -12085,6 +12389,8 @@
|
|
|
12085
12389
|
"EncodingBase64"
|
|
12086
12390
|
],
|
|
12087
12391
|
"default": "EncodingNone",
|
|
12392
|
+
"x-f5xc-description-short": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. ...",
|
|
12393
|
+
"x-f5xc-description-medium": "X-displayName: \"Secret Encoding\" SecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service. - EncodingNone: x-displayName: \"None\" No Encoding - EncodingBase64: Base64 x-displayName: \"Base64\" Base64 encoding.",
|
|
12088
12394
|
"x-f5xc-minimum-configuration": {
|
|
12089
12395
|
"description": "Minimum configuration for schemaSecretEncodingType",
|
|
12090
12396
|
"required_fields": [],
|
|
@@ -12110,6 +12416,7 @@
|
|
|
12110
12416
|
"$ref": "#/components/schemas/schemaClearSecretInfoType"
|
|
12111
12417
|
}
|
|
12112
12418
|
},
|
|
12419
|
+
"x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.",
|
|
12113
12420
|
"x-f5xc-minimum-configuration": {
|
|
12114
12421
|
"description": "Minimum configuration for schemaSecretType",
|
|
12115
12422
|
"required_fields": [
|
|
@@ -12166,6 +12473,7 @@
|
|
|
12166
12473
|
}
|
|
12167
12474
|
}
|
|
12168
12475
|
},
|
|
12476
|
+
"x-f5xc-description-short": "Specifies a direct reference to a site configuration object.",
|
|
12169
12477
|
"x-f5xc-minimum-configuration": {
|
|
12170
12478
|
"description": "Minimum configuration for schemaSiteRefType",
|
|
12171
12479
|
"required_fields": [
|
|
@@ -12194,6 +12502,8 @@
|
|
|
12194
12502
|
"title": "Creation_timestamp.",
|
|
12195
12503
|
"format": "date-time",
|
|
12196
12504
|
"x-displayname": "Creation Timestamp.",
|
|
12505
|
+
"x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
12506
|
+
"x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.",
|
|
12197
12507
|
"minLength": 0,
|
|
12198
12508
|
"maxLength": 1024,
|
|
12199
12509
|
"x-f5xc-required-for": {
|
|
@@ -12211,6 +12521,8 @@
|
|
|
12211
12521
|
"x-displayname": "Creator Class.",
|
|
12212
12522
|
"x-ves-example": "ver.re1.int.ves.I/O.",
|
|
12213
12523
|
"x-f5xc-example": "ver.re1.int.F5 XC",
|
|
12524
|
+
"x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.",
|
|
12525
|
+
"x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.",
|
|
12214
12526
|
"minLength": 0,
|
|
12215
12527
|
"maxLength": 1024,
|
|
12216
12528
|
"x-f5xc-required-for": {
|
|
@@ -12228,6 +12540,8 @@
|
|
|
12228
12540
|
"x-displayname": "Creator ID.",
|
|
12229
12541
|
"x-ves-example": "Ver-instance-1.",
|
|
12230
12542
|
"x-f5xc-example": "ver-instance-1",
|
|
12543
|
+
"x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.",
|
|
12544
|
+
"x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.",
|
|
12231
12545
|
"minLength": 0,
|
|
12232
12546
|
"maxLength": 1024,
|
|
12233
12547
|
"x-f5xc-required-for": {
|
|
@@ -12246,6 +12560,8 @@
|
|
|
12246
12560
|
"description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)",
|
|
12247
12561
|
"title": "Status_id",
|
|
12248
12562
|
"x-displayname": "Status ID",
|
|
12563
|
+
"x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...",
|
|
12564
|
+
"x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).",
|
|
12249
12565
|
"minLength": 0,
|
|
12250
12566
|
"maxLength": 1024,
|
|
12251
12567
|
"x-f5xc-required-for": {
|
|
@@ -12263,6 +12579,7 @@
|
|
|
12263
12579
|
"x-displayname": "UID",
|
|
12264
12580
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
12265
12581
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12582
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.",
|
|
12266
12583
|
"minLength": 0,
|
|
12267
12584
|
"maxLength": 36,
|
|
12268
12585
|
"x-f5xc-required-for": {
|
|
@@ -12275,13 +12592,14 @@
|
|
|
12275
12592
|
"x-original-maxLength": 1024,
|
|
12276
12593
|
"format": "uuid",
|
|
12277
12594
|
"x-reconciled-from-discovery": true,
|
|
12278
|
-
"x-reconciled-at": "2026-01-
|
|
12595
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397917+00:00"
|
|
12279
12596
|
},
|
|
12280
12597
|
"vtrp_id": {
|
|
12281
12598
|
"type": "string",
|
|
12282
12599
|
"description": "Origin of this status exchanged by VTRP.",
|
|
12283
12600
|
"title": "Vtrp_id",
|
|
12284
12601
|
"x-displayname": "VTRP ID",
|
|
12602
|
+
"x-f5xc-description-short": "Origin of this status exchanged by VTRP.",
|
|
12285
12603
|
"minLength": 0,
|
|
12286
12604
|
"maxLength": 1024,
|
|
12287
12605
|
"x-f5xc-required-for": {
|
|
@@ -12298,6 +12616,7 @@
|
|
|
12298
12616
|
"title": "Vtrp_stale.",
|
|
12299
12617
|
"format": "boolean",
|
|
12300
12618
|
"x-displayname": "VTRP Stale.",
|
|
12619
|
+
"x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.",
|
|
12301
12620
|
"x-f5xc-required-for": {
|
|
12302
12621
|
"minimum_config": false,
|
|
12303
12622
|
"create": false,
|
|
@@ -12306,6 +12625,7 @@
|
|
|
12306
12625
|
}
|
|
12307
12626
|
}
|
|
12308
12627
|
},
|
|
12628
|
+
"x-f5xc-description-short": "StatusMetaType is metadata that all status must have.",
|
|
12309
12629
|
"x-f5xc-minimum-configuration": {
|
|
12310
12630
|
"description": "Minimum configuration for schemaStatusMetaType",
|
|
12311
12631
|
"required_fields": [
|
|
@@ -12336,6 +12656,8 @@
|
|
|
12336
12656
|
"default": "STATUS_DO_NOT_PUBLISH",
|
|
12337
12657
|
"x-displayname": "Status Publish Type.",
|
|
12338
12658
|
"x-ves-proto-enum": "ves.io.schema.StatusPublishType",
|
|
12659
|
+
"x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.",
|
|
12660
|
+
"x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.",
|
|
12339
12661
|
"x-f5xc-minimum-configuration": {
|
|
12340
12662
|
"description": "Minimum configuration for schemaStatusPublishType",
|
|
12341
12663
|
"required_fields": [],
|
|
@@ -12361,6 +12683,7 @@
|
|
|
12361
12683
|
"x-displayname": "Code",
|
|
12362
12684
|
"x-ves-example": "0",
|
|
12363
12685
|
"x-f5xc-example": "0",
|
|
12686
|
+
"x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.",
|
|
12364
12687
|
"minimum": 0,
|
|
12365
12688
|
"maximum": 2147483647,
|
|
12366
12689
|
"x-f5xc-required-for": {
|
|
@@ -12377,6 +12700,8 @@
|
|
|
12377
12700
|
"x-displayname": "Reason",
|
|
12378
12701
|
"x-ves-example": "Value",
|
|
12379
12702
|
"x-f5xc-example": "value",
|
|
12703
|
+
"x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
12704
|
+
"x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.",
|
|
12380
12705
|
"minLength": 0,
|
|
12381
12706
|
"maxLength": 43,
|
|
12382
12707
|
"x-f5xc-required-for": {
|
|
@@ -12387,7 +12712,7 @@
|
|
|
12387
12712
|
},
|
|
12388
12713
|
"x-original-maxLength": 1024,
|
|
12389
12714
|
"x-reconciled-from-discovery": true,
|
|
12390
|
-
"x-reconciled-at": "2026-01-
|
|
12715
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397927+00:00"
|
|
12391
12716
|
},
|
|
12392
12717
|
"status": {
|
|
12393
12718
|
"type": "string",
|
|
@@ -12396,6 +12721,7 @@
|
|
|
12396
12721
|
"x-displayname": "Status",
|
|
12397
12722
|
"x-ves-example": "Value",
|
|
12398
12723
|
"x-f5xc-example": "value",
|
|
12724
|
+
"x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".",
|
|
12399
12725
|
"minLength": 0,
|
|
12400
12726
|
"maxLength": 17,
|
|
12401
12727
|
"x-f5xc-required-for": {
|
|
@@ -12406,9 +12732,10 @@
|
|
|
12406
12732
|
},
|
|
12407
12733
|
"x-original-maxLength": 1024,
|
|
12408
12734
|
"x-reconciled-from-discovery": true,
|
|
12409
|
-
"x-reconciled-at": "2026-01-
|
|
12735
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397931+00:00"
|
|
12410
12736
|
}
|
|
12411
12737
|
},
|
|
12738
|
+
"x-f5xc-description-short": "Status is a return value for calls that don't return other objects.",
|
|
12412
12739
|
"x-f5xc-minimum-configuration": {
|
|
12413
12740
|
"description": "Minimum configuration for schemaStatusType",
|
|
12414
12741
|
"required_fields": [
|
|
@@ -12436,6 +12763,8 @@
|
|
|
12436
12763
|
"title": "Creation_timestamp.",
|
|
12437
12764
|
"format": "date-time",
|
|
12438
12765
|
"x-displayname": "Creation Timestamp.",
|
|
12766
|
+
"x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.",
|
|
12767
|
+
"x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.",
|
|
12439
12768
|
"minLength": 0,
|
|
12440
12769
|
"maxLength": 1024,
|
|
12441
12770
|
"x-f5xc-required-for": {
|
|
@@ -12453,6 +12782,7 @@
|
|
|
12453
12782
|
"x-displayname": "Creator Class.",
|
|
12454
12783
|
"x-ves-example": "Prism",
|
|
12455
12784
|
"x-f5xc-example": "value",
|
|
12785
|
+
"x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.",
|
|
12456
12786
|
"minLength": 0,
|
|
12457
12787
|
"maxLength": 1024,
|
|
12458
12788
|
"x-f5xc-required-for": {
|
|
@@ -12470,6 +12800,7 @@
|
|
|
12470
12800
|
"x-displayname": "Creator ID.",
|
|
12471
12801
|
"x-ves-example": "Admin@example-corp.com.",
|
|
12472
12802
|
"x-f5xc-example": "value",
|
|
12803
|
+
"x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.",
|
|
12473
12804
|
"minLength": 0,
|
|
12474
12805
|
"maxLength": 1024,
|
|
12475
12806
|
"x-f5xc-required-for": {
|
|
@@ -12486,6 +12817,8 @@
|
|
|
12486
12817
|
"title": "Deletion_timestamp.",
|
|
12487
12818
|
"format": "date-time",
|
|
12488
12819
|
"x-displayname": "Deletion Timestamp.",
|
|
12820
|
+
"x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.",
|
|
12821
|
+
"x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...",
|
|
12489
12822
|
"minLength": 0,
|
|
12490
12823
|
"maxLength": 1024,
|
|
12491
12824
|
"x-f5xc-required-for": {
|
|
@@ -12505,6 +12838,8 @@
|
|
|
12505
12838
|
"x-displayname": "Finalizers.",
|
|
12506
12839
|
"x-ves-example": "Value",
|
|
12507
12840
|
"x-f5xc-example": "value",
|
|
12841
|
+
"x-f5xc-description-short": "Must be empty before the object is deleted from the registry.",
|
|
12842
|
+
"x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.",
|
|
12508
12843
|
"x-f5xc-required-for": {
|
|
12509
12844
|
"minimum_config": false,
|
|
12510
12845
|
"create": false,
|
|
@@ -12522,6 +12857,8 @@
|
|
|
12522
12857
|
"x-displayname": "Labels",
|
|
12523
12858
|
"x-ves-example": "'VES.I/O/soft-deleted': 'true'",
|
|
12524
12859
|
"x-f5xc-example": "'F5 XC/soft-deleted''true'",
|
|
12860
|
+
"x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.",
|
|
12861
|
+
"x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).",
|
|
12525
12862
|
"x-f5xc-required-for": {
|
|
12526
12863
|
"minimum_config": false,
|
|
12527
12864
|
"create": false,
|
|
@@ -12535,6 +12872,8 @@
|
|
|
12535
12872
|
"title": "Modification_timestamp.",
|
|
12536
12873
|
"format": "date-time",
|
|
12537
12874
|
"x-displayname": "Modification Timestamp.",
|
|
12875
|
+
"x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
12876
|
+
"x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.",
|
|
12538
12877
|
"minLength": 0,
|
|
12539
12878
|
"maxLength": 1024,
|
|
12540
12879
|
"x-f5xc-required-for": {
|
|
@@ -12553,6 +12892,8 @@
|
|
|
12553
12892
|
"x-displayname": "Object Index.",
|
|
12554
12893
|
"x-ves-example": "0",
|
|
12555
12894
|
"x-f5xc-example": "0",
|
|
12895
|
+
"x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.",
|
|
12896
|
+
"x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.",
|
|
12556
12897
|
"minimum": 0,
|
|
12557
12898
|
"maximum": 2147483647,
|
|
12558
12899
|
"x-f5xc-required-for": {
|
|
@@ -12573,6 +12914,8 @@
|
|
|
12573
12914
|
"x-displayname": "Tenant",
|
|
12574
12915
|
"x-ves-example": "Example-corp.",
|
|
12575
12916
|
"x-f5xc-example": "example-corp",
|
|
12917
|
+
"x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
12918
|
+
"x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.",
|
|
12576
12919
|
"minLength": 0,
|
|
12577
12920
|
"maxLength": 18,
|
|
12578
12921
|
"x-f5xc-required-for": {
|
|
@@ -12584,7 +12927,7 @@
|
|
|
12584
12927
|
"x-field-mutability": "read-only",
|
|
12585
12928
|
"x-original-maxLength": 1024,
|
|
12586
12929
|
"x-reconciled-from-discovery": true,
|
|
12587
|
-
"x-reconciled-at": "2026-01-
|
|
12930
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397950+00:00"
|
|
12588
12931
|
},
|
|
12589
12932
|
"uid": {
|
|
12590
12933
|
"type": "string",
|
|
@@ -12593,6 +12936,8 @@
|
|
|
12593
12936
|
"x-displayname": "UID",
|
|
12594
12937
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
12595
12938
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
12939
|
+
"x-f5xc-description-short": "Uid is the unique in time and space value for this object.",
|
|
12940
|
+
"x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.",
|
|
12596
12941
|
"minLength": 0,
|
|
12597
12942
|
"maxLength": 36,
|
|
12598
12943
|
"x-f5xc-required-for": {
|
|
@@ -12605,9 +12950,11 @@
|
|
|
12605
12950
|
"x-original-maxLength": 1024,
|
|
12606
12951
|
"format": "uuid",
|
|
12607
12952
|
"x-reconciled-from-discovery": true,
|
|
12608
|
-
"x-reconciled-at": "2026-01-
|
|
12953
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397955+00:00"
|
|
12609
12954
|
}
|
|
12610
12955
|
},
|
|
12956
|
+
"x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
12957
|
+
"x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.",
|
|
12611
12958
|
"x-f5xc-minimum-configuration": {
|
|
12612
12959
|
"description": "Minimum configuration for schemaSystemObjectGetMetaType",
|
|
12613
12960
|
"required_fields": [
|
|
@@ -12661,6 +13008,8 @@
|
|
|
12661
13008
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
12662
13009
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
12663
13010
|
},
|
|
13011
|
+
"x-f5xc-description-short": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers.",
|
|
13012
|
+
"x-f5xc-description-medium": "TLS certificate. Certificate or certificate chain in PEM format including the PEM headers. Required: YES.",
|
|
12664
13013
|
"x-f5xc-required-for": {
|
|
12665
13014
|
"minimum_config": false,
|
|
12666
13015
|
"create": false,
|
|
@@ -12688,7 +13037,7 @@
|
|
|
12688
13037
|
},
|
|
12689
13038
|
"x-original-maxLength": 1024,
|
|
12690
13039
|
"x-reconciled-from-discovery": true,
|
|
12691
|
-
"x-reconciled-at": "2026-01-
|
|
13040
|
+
"x-reconciled-at": "2026-01-07T15:53:57.397963+00:00"
|
|
12692
13041
|
},
|
|
12693
13042
|
"disable_ocsp_stapling": {
|
|
12694
13043
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
@@ -12743,6 +13092,8 @@
|
|
|
12743
13092
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
12744
13093
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
12745
13094
|
},
|
|
13095
|
+
"x-f5xc-description-short": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256...",
|
|
13096
|
+
"x-f5xc-description-medium": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...",
|
|
12746
13097
|
"x-f5xc-required-for": {
|
|
12747
13098
|
"minimum_config": false,
|
|
12748
13099
|
"create": false,
|
|
@@ -12775,6 +13126,8 @@
|
|
|
12775
13126
|
"$ref": "#/components/schemas/schemaTlsValidationParamsType"
|
|
12776
13127
|
}
|
|
12777
13128
|
},
|
|
13129
|
+
"x-f5xc-description-short": "Information of different aspects for TLS authentication related to ciphers, certificates and trust store.",
|
|
13130
|
+
"x-f5xc-description-medium": "Information of different aspects for TLS authentication related to ciphers, certificates and trust store.",
|
|
12778
13131
|
"x-f5xc-minimum-configuration": {
|
|
12779
13132
|
"description": "Minimum configuration for schemaTlsParamsType",
|
|
12780
13133
|
"required_fields": [
|
|
@@ -12805,6 +13158,8 @@
|
|
|
12805
13158
|
"default": "TLS_AUTO",
|
|
12806
13159
|
"x-displayname": "TLS Protocol.",
|
|
12807
13160
|
"x-ves-proto-enum": "ves.io.schema.TlsProtocol",
|
|
13161
|
+
"x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
13162
|
+
"x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.",
|
|
12808
13163
|
"x-f5xc-minimum-configuration": {
|
|
12809
13164
|
"description": "Minimum configuration for schemaTlsProtocol",
|
|
12810
13165
|
"required_fields": [],
|
|
@@ -12829,6 +13184,9 @@
|
|
|
12829
13184
|
"title": "Skip_hostname_verification.",
|
|
12830
13185
|
"format": "boolean",
|
|
12831
13186
|
"x-displayname": "Skip verification of hostname.",
|
|
13187
|
+
"x-f5xc-example": "example-resource",
|
|
13188
|
+
"x-f5xc-description-short": "When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname.",
|
|
13189
|
+
"x-f5xc-description-medium": "When True, skip verification of hostname i.e. CN/Subject Alt Name of certificate is not matched to the connecting hostname.",
|
|
12832
13190
|
"x-f5xc-required-for": {
|
|
12833
13191
|
"minimum_config": false,
|
|
12834
13192
|
"create": false,
|
|
@@ -12853,6 +13211,7 @@
|
|
|
12853
13211
|
"ves.io.schema.rules.string.max_bytes": "131072",
|
|
12854
13212
|
"ves.io.schema.rules.string.truststore_url": "true"
|
|
12855
13213
|
},
|
|
13214
|
+
"x-f5xc-description-short": "Exclusive with [trusted_ca] Inline Root CA Certificate.",
|
|
12856
13215
|
"minLength": 0,
|
|
12857
13216
|
"x-f5xc-required-for": {
|
|
12858
13217
|
"minimum_config": false,
|
|
@@ -12871,6 +13230,8 @@
|
|
|
12871
13230
|
"x-displayname": "List of SANs for matching.",
|
|
12872
13231
|
"x-ves-example": "Value",
|
|
12873
13232
|
"x-f5xc-example": "value",
|
|
13233
|
+
"x-f5xc-description-short": "List of acceptable Subject Alt Names/CN in the peer's certificate.",
|
|
13234
|
+
"x-f5xc-description-medium": "List of acceptable Subject Alt Names/CN in the peer's certificate. When skip_hostname_verification is false and verify_subject_alt_names is empty, the hostname of the peer will be used for matching against SAN/CN of peer's certificate.",
|
|
12874
13235
|
"x-f5xc-required-for": {
|
|
12875
13236
|
"minimum_config": false,
|
|
12876
13237
|
"create": false,
|
|
@@ -12879,6 +13240,8 @@
|
|
|
12879
13240
|
}
|
|
12880
13241
|
}
|
|
12881
13242
|
},
|
|
13243
|
+
"x-f5xc-description-short": "Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification.",
|
|
13244
|
+
"x-f5xc-description-medium": "Includes URL for a trust store, whether SAN verification is required and list of Subject Alt Names for verification.",
|
|
12882
13245
|
"x-f5xc-minimum-configuration": {
|
|
12883
13246
|
"description": "Minimum configuration for schemaTlsValidationParamsType",
|
|
12884
13247
|
"required_fields": [
|
|
@@ -12947,6 +13310,7 @@
|
|
|
12947
13310
|
"default": "HTTP",
|
|
12948
13311
|
"x-displayname": "URL Scheme.",
|
|
12949
13312
|
"x-ves-proto-enum": "ves.io.schema.URLSchemeType",
|
|
13313
|
+
"x-f5xc-description-short": "SchemeType is used to indicate URL scheme HTTP:// scheme HTTPS:// scheme.",
|
|
12950
13314
|
"x-f5xc-minimum-configuration": {
|
|
12951
13315
|
"description": "Minimum configuration for schemaURLSchemeType",
|
|
12952
13316
|
"required_fields": [],
|
|
@@ -12984,6 +13348,7 @@
|
|
|
12984
13348
|
"ves.io.schema.rules.string.max_len": "1",
|
|
12985
13349
|
"ves.io.schema.rules.string.min_len": "1"
|
|
12986
13350
|
},
|
|
13351
|
+
"x-f5xc-description-short": "Client TLS Certificate required for mTLS authentication Required: YES.",
|
|
12987
13352
|
"x-f5xc-required-for": {
|
|
12988
13353
|
"minimum_config": false,
|
|
12989
13354
|
"create": false,
|
|
@@ -13009,6 +13374,8 @@
|
|
|
13009
13374
|
"ves.io.schema.rules.repeated.items.string.in": "[\\\"TLS_AES_128_GCM_SHA256\\\",\\\"TLS_AES_256_GCM_SHA384\\\",\\\"TLS_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\",\\\"TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_128_GCM_SHA256\\\",\\\"TLS_RSA_WITH_AES_256_CBC_SHA\\\",\\\"TLS_RSA_WITH_AES_256_GCM_SHA384\\\"]",
|
|
13010
13375
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
13011
13376
|
},
|
|
13377
|
+
"x-f5xc-description-short": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256...",
|
|
13378
|
+
"x-f5xc-description-medium": "The following list specifies the supported cipher suite TLS_AES_128_GCM_SHA256 TLS_AES_256_GCM_SHA384 TLS_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256...",
|
|
13012
13379
|
"x-f5xc-required-for": {
|
|
13013
13380
|
"minimum_config": false,
|
|
13014
13381
|
"create": false,
|
|
@@ -13026,6 +13393,7 @@
|
|
|
13026
13393
|
"$ref": "#/components/schemas/schemaTlsValidationParamsType"
|
|
13027
13394
|
}
|
|
13028
13395
|
},
|
|
13396
|
+
"x-f5xc-description-short": "Certificate Parameters for authentication, TLS ciphers, and trust store.",
|
|
13029
13397
|
"x-f5xc-minimum-configuration": {
|
|
13030
13398
|
"description": "Minimum configuration for schemaUpstreamCertificateParamsType",
|
|
13031
13399
|
"required_fields": [
|
|
@@ -13083,6 +13451,8 @@
|
|
|
13083
13451
|
"ves.io.schema.rules.uint32.gte": "2",
|
|
13084
13452
|
"ves.io.schema.rules.uint32.lte": "64"
|
|
13085
13453
|
},
|
|
13454
|
+
"x-f5xc-description-short": "Exclusive with [default_session_key_caching disable_session_key_caching] Number of session keys that are cached.",
|
|
13455
|
+
"x-f5xc-description-medium": "Exclusive with [default_session_key_caching disable_session_key_caching] Number of session keys that are cached.",
|
|
13086
13456
|
"minimum": 0,
|
|
13087
13457
|
"maximum": 2147483647,
|
|
13088
13458
|
"x-f5xc-required-for": {
|
|
@@ -13106,6 +13476,7 @@
|
|
|
13106
13476
|
"ves.io.schema.rules.string.hostname": "true",
|
|
13107
13477
|
"ves.io.schema.rules.string.max_len": "256"
|
|
13108
13478
|
},
|
|
13479
|
+
"x-f5xc-description-short": "Exclusive with [disable_sni use_host_header_as_sni] SNI value to be used.",
|
|
13109
13480
|
"minLength": 0,
|
|
13110
13481
|
"x-f5xc-required-for": {
|
|
13111
13482
|
"minimum_config": false,
|
|
@@ -13118,6 +13489,7 @@
|
|
|
13118
13489
|
"$ref": "#/components/schemas/ioschemaEmpty"
|
|
13119
13490
|
}
|
|
13120
13491
|
},
|
|
13492
|
+
"x-f5xc-description-short": "TLS configuration for upstream connections.",
|
|
13121
13493
|
"x-f5xc-minimum-configuration": {
|
|
13122
13494
|
"description": "Minimum configuration for schemaUpstreamTlsParamsType",
|
|
13123
13495
|
"required_fields": [
|
|
@@ -13172,6 +13544,7 @@
|
|
|
13172
13544
|
"ves.io.schema.rules.message.required": "true",
|
|
13173
13545
|
"ves.io.schema.rules.repeated.max_items": "1"
|
|
13174
13546
|
},
|
|
13547
|
+
"x-f5xc-description-short": "Virtual_site direct reference Required: YES.",
|
|
13175
13548
|
"x-f5xc-required-for": {
|
|
13176
13549
|
"minimum_config": false,
|
|
13177
13550
|
"create": false,
|
|
@@ -13210,6 +13583,7 @@
|
|
|
13210
13583
|
"$ref": "#/components/schemas/schemaSecretType"
|
|
13211
13584
|
}
|
|
13212
13585
|
},
|
|
13586
|
+
"x-f5xc-description-short": "Authentication parameters for Hashicorp Vault hosts.",
|
|
13213
13587
|
"x-f5xc-minimum-configuration": {
|
|
13214
13588
|
"description": "Minimum configuration for schemaVaultAuthInfoType",
|
|
13215
13589
|
"required_fields": [
|
|
@@ -13233,6 +13607,8 @@
|
|
|
13233
13607
|
"description": "X-displayName: \"Key\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.",
|
|
13234
13608
|
"title": "Key",
|
|
13235
13609
|
"x-f5xc-example": "key_pem",
|
|
13610
|
+
"x-f5xc-description-short": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair.",
|
|
13611
|
+
"x-f5xc-description-medium": "X-displayName: \"Key\" Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key.",
|
|
13236
13612
|
"minLength": 0,
|
|
13237
13613
|
"maxLength": 16,
|
|
13238
13614
|
"x-f5xc-required-for": {
|
|
@@ -13243,13 +13619,14 @@
|
|
|
13243
13619
|
},
|
|
13244
13620
|
"x-original-maxLength": 1024,
|
|
13245
13621
|
"x-reconciled-from-discovery": true,
|
|
13246
|
-
"x-reconciled-at": "2026-01-
|
|
13622
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398011+00:00"
|
|
13247
13623
|
},
|
|
13248
13624
|
"location": {
|
|
13249
13625
|
"type": "string",
|
|
13250
13626
|
"description": "X-displayName: \"Location\"\nx-required\nPath to secret in Vault.",
|
|
13251
13627
|
"title": "Location",
|
|
13252
13628
|
"x-f5xc-example": "v1/data/vhost_key",
|
|
13629
|
+
"x-f5xc-description-short": "X-displayName: \"Location\" x-required Path to secret in Vault.",
|
|
13253
13630
|
"minLength": 0,
|
|
13254
13631
|
"maxLength": 4,
|
|
13255
13632
|
"x-f5xc-required-for": {
|
|
@@ -13260,13 +13637,15 @@
|
|
|
13260
13637
|
},
|
|
13261
13638
|
"x-original-maxLength": 1024,
|
|
13262
13639
|
"x-reconciled-from-discovery": true,
|
|
13263
|
-
"x-reconciled-at": "2026-01-
|
|
13640
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398016+00:00"
|
|
13264
13641
|
},
|
|
13265
13642
|
"provider": {
|
|
13266
13643
|
"type": "string",
|
|
13267
13644
|
"description": "X-displayName: \"Provider\"\nx-required\nName of the Secret Management Access object that contains information about the backend Vault.",
|
|
13268
13645
|
"title": "Provider",
|
|
13269
13646
|
"x-f5xc-example": "vault-vh-provider",
|
|
13647
|
+
"x-f5xc-description-short": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
13648
|
+
"x-f5xc-description-medium": "X-displayName: \"Provider\" x-required Name of the Secret Management Access object that contains information about the backend Vault.",
|
|
13270
13649
|
"minLength": 0,
|
|
13271
13650
|
"maxLength": 8,
|
|
13272
13651
|
"x-f5xc-required-for": {
|
|
@@ -13277,7 +13656,7 @@
|
|
|
13277
13656
|
},
|
|
13278
13657
|
"x-original-maxLength": 1024,
|
|
13279
13658
|
"x-reconciled-from-discovery": true,
|
|
13280
|
-
"x-reconciled-at": "2026-01-
|
|
13659
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398020+00:00"
|
|
13281
13660
|
},
|
|
13282
13661
|
"secret_encoding": {
|
|
13283
13662
|
"$ref": "#/components/schemas/schemaSecretEncodingType"
|
|
@@ -13288,6 +13667,8 @@
|
|
|
13288
13667
|
"title": "Version",
|
|
13289
13668
|
"format": "int64",
|
|
13290
13669
|
"x-f5xc-example": "1",
|
|
13670
|
+
"x-f5xc-description-short": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.",
|
|
13671
|
+
"x-f5xc-description-medium": "X-displayName: \"Version\" Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.",
|
|
13291
13672
|
"minimum": 0,
|
|
13292
13673
|
"maximum": 2147483647,
|
|
13293
13674
|
"x-f5xc-required-for": {
|
|
@@ -13299,9 +13680,11 @@
|
|
|
13299
13680
|
"maxLength": 1,
|
|
13300
13681
|
"minLength": 1,
|
|
13301
13682
|
"x-reconciled-from-discovery": true,
|
|
13302
|
-
"x-reconciled-at": "2026-01-
|
|
13683
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398026+00:00"
|
|
13303
13684
|
}
|
|
13304
13685
|
},
|
|
13686
|
+
"x-f5xc-description-short": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
13687
|
+
"x-f5xc-description-medium": "X-displayName: \"Vault Secret\" VaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.",
|
|
13305
13688
|
"x-f5xc-minimum-configuration": {
|
|
13306
13689
|
"description": "Minimum configuration for schemaVaultSecretInfoType",
|
|
13307
13690
|
"required_fields": [
|
|
@@ -13342,7 +13725,7 @@
|
|
|
13342
13725
|
},
|
|
13343
13726
|
"x-original-maxLength": 1024,
|
|
13344
13727
|
"x-reconciled-from-discovery": true,
|
|
13345
|
-
"x-reconciled-at": "2026-01-
|
|
13728
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398031+00:00"
|
|
13346
13729
|
},
|
|
13347
13730
|
"name": {
|
|
13348
13731
|
"type": "string",
|
|
@@ -13351,6 +13734,8 @@
|
|
|
13351
13734
|
"x-displayname": "Name",
|
|
13352
13735
|
"x-ves-example": "Contactus-route.",
|
|
13353
13736
|
"x-f5xc-example": "contactus-route",
|
|
13737
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
13738
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
13354
13739
|
"minLength": 0,
|
|
13355
13740
|
"maxLength": 16,
|
|
13356
13741
|
"x-f5xc-required-for": {
|
|
@@ -13361,7 +13746,7 @@
|
|
|
13361
13746
|
},
|
|
13362
13747
|
"x-original-maxLength": 1024,
|
|
13363
13748
|
"x-reconciled-from-discovery": true,
|
|
13364
|
-
"x-reconciled-at": "2026-01-
|
|
13749
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398036+00:00"
|
|
13365
13750
|
},
|
|
13366
13751
|
"namespace": {
|
|
13367
13752
|
"type": "string",
|
|
@@ -13370,6 +13755,8 @@
|
|
|
13370
13755
|
"x-displayname": "Namespace",
|
|
13371
13756
|
"x-ves-example": "Ns1",
|
|
13372
13757
|
"x-f5xc-example": "ns1",
|
|
13758
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
13759
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
13373
13760
|
"minLength": 0,
|
|
13374
13761
|
"maxLength": 6,
|
|
13375
13762
|
"x-f5xc-required-for": {
|
|
@@ -13380,7 +13767,7 @@
|
|
|
13380
13767
|
},
|
|
13381
13768
|
"x-original-maxLength": 1024,
|
|
13382
13769
|
"x-reconciled-from-discovery": true,
|
|
13383
|
-
"x-reconciled-at": "2026-01-
|
|
13770
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398040+00:00"
|
|
13384
13771
|
},
|
|
13385
13772
|
"uid": {
|
|
13386
13773
|
"type": "string",
|
|
@@ -13401,9 +13788,10 @@
|
|
|
13401
13788
|
"x-original-maxLength": 1024,
|
|
13402
13789
|
"format": "uuid",
|
|
13403
13790
|
"x-reconciled-from-discovery": true,
|
|
13404
|
-
"x-reconciled-at": "2026-01-
|
|
13791
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398045+00:00"
|
|
13405
13792
|
}
|
|
13406
13793
|
},
|
|
13794
|
+
"x-f5xc-description-short": "ViewRefType represents a reference to a view.",
|
|
13407
13795
|
"x-f5xc-minimum-configuration": {
|
|
13408
13796
|
"description": "Minimum configuration for schemaViewRefType",
|
|
13409
13797
|
"required_fields": [
|
|
@@ -13441,6 +13829,8 @@
|
|
|
13441
13829
|
"default": "VIRTUAL_NETWORK_SITE_LOCAL",
|
|
13442
13830
|
"x-displayname": "Virtual Network Type.",
|
|
13443
13831
|
"x-ves-proto-enum": "ves.io.schema.VirtualNetworkType",
|
|
13832
|
+
"x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...",
|
|
13833
|
+
"x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...",
|
|
13444
13834
|
"x-f5xc-minimum-configuration": {
|
|
13445
13835
|
"description": "Minimum configuration for schemaVirtualNetworkType",
|
|
13446
13836
|
"required_fields": [],
|
|
@@ -13461,6 +13851,7 @@
|
|
|
13461
13851
|
"description": "X-displayName: \"Name\"\nx-required\nName of the secret.",
|
|
13462
13852
|
"title": "Name",
|
|
13463
13853
|
"x-f5xc-example": "ChargeBack-API-Key",
|
|
13854
|
+
"x-f5xc-description-short": "X-displayName: \"Name\" x-required Name of the secret.",
|
|
13464
13855
|
"minLength": 0,
|
|
13465
13856
|
"maxLength": 16,
|
|
13466
13857
|
"x-f5xc-required-for": {
|
|
@@ -13471,9 +13862,10 @@
|
|
|
13471
13862
|
},
|
|
13472
13863
|
"x-original-maxLength": 1024,
|
|
13473
13864
|
"x-reconciled-from-discovery": true,
|
|
13474
|
-
"x-reconciled-at": "2026-01-
|
|
13865
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398050+00:00"
|
|
13475
13866
|
}
|
|
13476
13867
|
},
|
|
13868
|
+
"x-f5xc-description-short": "X-displayName: \"Wingman Secret\" WingmanSecretInfoType specifies the handle to the wingman secret.",
|
|
13477
13869
|
"x-f5xc-minimum-configuration": {
|
|
13478
13870
|
"description": "Minimum configuration for schemaWingmanSecretInfoType",
|
|
13479
13871
|
"required_fields": [
|
|
@@ -13571,6 +13963,8 @@
|
|
|
13571
13963
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13572
13964
|
"ves.io.schema.rules.string.min_len": "1"
|
|
13573
13965
|
},
|
|
13966
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13967
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13574
13968
|
"x-f5xc-required-for": {
|
|
13575
13969
|
"minimum_config": false,
|
|
13576
13970
|
"create": false,
|
|
@@ -13582,6 +13976,7 @@
|
|
|
13582
13976
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
13583
13977
|
}
|
|
13584
13978
|
},
|
|
13979
|
+
"x-f5xc-description-short": "Create secret_management_access creates a new object in storage backend for metadata.namespace.",
|
|
13585
13980
|
"x-f5xc-minimum-configuration": {
|
|
13586
13981
|
"description": "Minimum configuration for secret_management_accessCreateSpecType",
|
|
13587
13982
|
"required_fields": [
|
|
@@ -13609,6 +14004,7 @@
|
|
|
13609
14004
|
"title": "Fail_if_referred.",
|
|
13610
14005
|
"format": "boolean",
|
|
13611
14006
|
"x-displayname": "Fail-If-Referred.",
|
|
14007
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
13612
14008
|
"x-f5xc-required-for": {
|
|
13613
14009
|
"minimum_config": false,
|
|
13614
14010
|
"create": false,
|
|
@@ -13633,7 +14029,7 @@
|
|
|
13633
14029
|
},
|
|
13634
14030
|
"x-original-maxLength": 1024,
|
|
13635
14031
|
"x-reconciled-from-discovery": true,
|
|
13636
|
-
"x-reconciled-at": "2026-01-
|
|
14032
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398067+00:00"
|
|
13637
14033
|
},
|
|
13638
14034
|
"namespace": {
|
|
13639
14035
|
"type": "string",
|
|
@@ -13642,6 +14038,7 @@
|
|
|
13642
14038
|
"x-displayname": "Namespace",
|
|
13643
14039
|
"x-ves-example": "Ns1",
|
|
13644
14040
|
"x-f5xc-example": "ns1",
|
|
14041
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
13645
14042
|
"minLength": 0,
|
|
13646
14043
|
"maxLength": 6,
|
|
13647
14044
|
"x-f5xc-required-for": {
|
|
@@ -13652,7 +14049,7 @@
|
|
|
13652
14049
|
},
|
|
13653
14050
|
"x-original-maxLength": 1024,
|
|
13654
14051
|
"x-reconciled-from-discovery": true,
|
|
13655
|
-
"x-reconciled-at": "2026-01-
|
|
14052
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398071+00:00"
|
|
13656
14053
|
}
|
|
13657
14054
|
},
|
|
13658
14055
|
"x-f5xc-minimum-configuration": {
|
|
@@ -13687,6 +14084,7 @@
|
|
|
13687
14084
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13688
14085
|
},
|
|
13689
14086
|
"x-displayname": "Deleted Referred Objects.",
|
|
14087
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
13690
14088
|
"x-f5xc-required-for": {
|
|
13691
14089
|
"minimum_config": false,
|
|
13692
14090
|
"create": false,
|
|
@@ -13702,6 +14100,7 @@
|
|
|
13702
14100
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13703
14101
|
},
|
|
13704
14102
|
"x-displayname": "Disabled Referred Objects.",
|
|
14103
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
13705
14104
|
"x-f5xc-required-for": {
|
|
13706
14105
|
"minimum_config": false,
|
|
13707
14106
|
"create": false,
|
|
@@ -13720,6 +14119,7 @@
|
|
|
13720
14119
|
"$ref": "#/components/schemas/schemaObjectRefType"
|
|
13721
14120
|
},
|
|
13722
14121
|
"x-displayname": "Referring Objects.",
|
|
14122
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
13723
14123
|
"x-f5xc-required-for": {
|
|
13724
14124
|
"minimum_config": false,
|
|
13725
14125
|
"create": false,
|
|
@@ -13741,6 +14141,8 @@
|
|
|
13741
14141
|
"$ref": "#/components/schemas/secret_management_accessStatusObject"
|
|
13742
14142
|
},
|
|
13743
14143
|
"x-displayname": "Status",
|
|
14144
|
+
"x-f5xc-example": "active",
|
|
14145
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
13744
14146
|
"x-f5xc-required-for": {
|
|
13745
14147
|
"minimum_config": false,
|
|
13746
14148
|
"create": false,
|
|
@@ -13750,7 +14152,7 @@
|
|
|
13750
14152
|
"maxLength": 17,
|
|
13751
14153
|
"minLength": 17,
|
|
13752
14154
|
"x-reconciled-from-discovery": true,
|
|
13753
|
-
"x-reconciled-at": "2026-01-
|
|
14155
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398085+00:00"
|
|
13754
14156
|
},
|
|
13755
14157
|
"system_metadata": {
|
|
13756
14158
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -13790,6 +14192,8 @@
|
|
|
13790
14192
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
13791
14193
|
],
|
|
13792
14194
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
14195
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
14196
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
13793
14197
|
"x-f5xc-minimum-configuration": {
|
|
13794
14198
|
"description": "Minimum configuration for secret_management_accessGetResponseFormatCode",
|
|
13795
14199
|
"required_fields": [],
|
|
@@ -13830,6 +14234,8 @@
|
|
|
13830
14234
|
"ves.io.schema.rules.string.max_len": "256",
|
|
13831
14235
|
"ves.io.schema.rules.string.min_len": "1"
|
|
13832
14236
|
},
|
|
14237
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
14238
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
13833
14239
|
"x-f5xc-required-for": {
|
|
13834
14240
|
"minimum_config": false,
|
|
13835
14241
|
"create": false,
|
|
@@ -13841,6 +14247,7 @@
|
|
|
13841
14247
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
13842
14248
|
}
|
|
13843
14249
|
},
|
|
14250
|
+
"x-f5xc-description-short": "GET secret_management_access reads a given object from storage backend for metadata.namespace.",
|
|
13844
14251
|
"x-f5xc-minimum-configuration": {
|
|
13845
14252
|
"description": "Minimum configuration for secret_management_accessGetSpecType",
|
|
13846
14253
|
"required_fields": [
|
|
@@ -13870,6 +14277,7 @@
|
|
|
13870
14277
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
13871
14278
|
},
|
|
13872
14279
|
"x-displayname": "Errors",
|
|
14280
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
13873
14281
|
"x-f5xc-required-for": {
|
|
13874
14282
|
"minimum_config": false,
|
|
13875
14283
|
"create": false,
|
|
@@ -13885,6 +14293,8 @@
|
|
|
13885
14293
|
"$ref": "#/components/schemas/secret_management_accessListResponseItem"
|
|
13886
14294
|
},
|
|
13887
14295
|
"x-displayname": "Items",
|
|
14296
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
14297
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
13888
14298
|
"x-f5xc-required-for": {
|
|
13889
14299
|
"minimum_config": false,
|
|
13890
14300
|
"create": false,
|
|
@@ -13918,6 +14328,8 @@
|
|
|
13918
14328
|
"description": "The set of annotations present on this secret_management_access.",
|
|
13919
14329
|
"title": "Annotations.",
|
|
13920
14330
|
"x-displayname": "Annotations.",
|
|
14331
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14332
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_management_access.",
|
|
13921
14333
|
"x-f5xc-required-for": {
|
|
13922
14334
|
"minimum_config": false,
|
|
13923
14335
|
"create": false,
|
|
@@ -13930,6 +14342,7 @@
|
|
|
13930
14342
|
"description": "The description set for this secret_management_access.",
|
|
13931
14343
|
"title": "Description.",
|
|
13932
14344
|
"x-displayname": "Description.",
|
|
14345
|
+
"x-f5xc-description-short": "The description set for this secret_management_access.",
|
|
13933
14346
|
"minLength": 0,
|
|
13934
14347
|
"maxLength": 0,
|
|
13935
14348
|
"x-f5xc-required-for": {
|
|
@@ -13940,7 +14353,7 @@
|
|
|
13940
14353
|
},
|
|
13941
14354
|
"x-original-maxLength": 1024,
|
|
13942
14355
|
"x-reconciled-from-discovery": true,
|
|
13943
|
-
"x-reconciled-at": "2026-01-
|
|
14356
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398100+00:00"
|
|
13944
14357
|
},
|
|
13945
14358
|
"disabled": {
|
|
13946
14359
|
"type": "boolean",
|
|
@@ -13948,6 +14361,8 @@
|
|
|
13948
14361
|
"title": "Disabled",
|
|
13949
14362
|
"format": "boolean",
|
|
13950
14363
|
"x-displayname": "Disabled",
|
|
14364
|
+
"x-f5xc-example": "True",
|
|
14365
|
+
"x-f5xc-description-short": "Value of true indicates secret_management_access is administratively disabled.",
|
|
13951
14366
|
"x-f5xc-required-for": {
|
|
13952
14367
|
"minimum_config": false,
|
|
13953
14368
|
"create": false,
|
|
@@ -13963,6 +14378,8 @@
|
|
|
13963
14378
|
"description": "The set of labels present on this secret_management_access.",
|
|
13964
14379
|
"title": "Labels",
|
|
13965
14380
|
"x-displayname": "Labels",
|
|
14381
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
14382
|
+
"x-f5xc-description-short": "The set of labels present on this secret_management_access.",
|
|
13966
14383
|
"x-f5xc-required-for": {
|
|
13967
14384
|
"minimum_config": false,
|
|
13968
14385
|
"create": false,
|
|
@@ -13980,6 +14397,7 @@
|
|
|
13980
14397
|
"x-displayname": "Name",
|
|
13981
14398
|
"x-ves-example": "Name",
|
|
13982
14399
|
"x-f5xc-example": "name",
|
|
14400
|
+
"x-f5xc-description-short": "The name of this secret_management_access.",
|
|
13983
14401
|
"minLength": 0,
|
|
13984
14402
|
"maxLength": 16,
|
|
13985
14403
|
"x-f5xc-required-for": {
|
|
@@ -13990,7 +14408,7 @@
|
|
|
13990
14408
|
},
|
|
13991
14409
|
"x-original-maxLength": 1024,
|
|
13992
14410
|
"x-reconciled-from-discovery": true,
|
|
13993
|
-
"x-reconciled-at": "2026-01-
|
|
14411
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398110+00:00"
|
|
13994
14412
|
},
|
|
13995
14413
|
"namespace": {
|
|
13996
14414
|
"type": "string",
|
|
@@ -14009,7 +14427,7 @@
|
|
|
14009
14427
|
},
|
|
14010
14428
|
"x-original-maxLength": 1024,
|
|
14011
14429
|
"x-reconciled-from-discovery": true,
|
|
14012
|
-
"x-reconciled-at": "2026-01-
|
|
14430
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398114+00:00"
|
|
14013
14431
|
},
|
|
14014
14432
|
"owner_view": {
|
|
14015
14433
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -14022,6 +14440,7 @@
|
|
|
14022
14440
|
"$ref": "#/components/schemas/secret_management_accessStatusObject"
|
|
14023
14441
|
},
|
|
14024
14442
|
"x-displayname": "Status",
|
|
14443
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
14025
14444
|
"x-f5xc-required-for": {
|
|
14026
14445
|
"minimum_config": false,
|
|
14027
14446
|
"create": false,
|
|
@@ -14050,7 +14469,7 @@
|
|
|
14050
14469
|
"x-field-mutability": "read-only",
|
|
14051
14470
|
"x-original-maxLength": 1024,
|
|
14052
14471
|
"x-reconciled-from-discovery": true,
|
|
14053
|
-
"x-reconciled-at": "2026-01-
|
|
14472
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398121+00:00"
|
|
14054
14473
|
},
|
|
14055
14474
|
"uid": {
|
|
14056
14475
|
"type": "string",
|
|
@@ -14059,6 +14478,7 @@
|
|
|
14059
14478
|
"x-displayname": "UID",
|
|
14060
14479
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
14061
14480
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
14481
|
+
"x-f5xc-description-short": "The unique uid of this secret_management_access.",
|
|
14062
14482
|
"minLength": 0,
|
|
14063
14483
|
"maxLength": 36,
|
|
14064
14484
|
"x-f5xc-required-for": {
|
|
@@ -14071,9 +14491,11 @@
|
|
|
14071
14491
|
"x-original-maxLength": 1024,
|
|
14072
14492
|
"format": "uuid",
|
|
14073
14493
|
"x-reconciled-from-discovery": true,
|
|
14074
|
-
"x-reconciled-at": "2026-01-
|
|
14494
|
+
"x-reconciled-at": "2026-01-07T15:53:57.398126+00:00"
|
|
14075
14495
|
}
|
|
14076
14496
|
},
|
|
14497
|
+
"x-f5xc-description-short": "By default a summary of secret_management_access is returned in 'List'.",
|
|
14498
|
+
"x-f5xc-description-medium": "By default a summary of secret_management_access is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
14077
14499
|
"x-f5xc-minimum-configuration": {
|
|
14078
14500
|
"description": "Minimum configuration for secret_management_accessListResponseItem",
|
|
14079
14501
|
"required_fields": [
|
|
@@ -14168,6 +14590,8 @@
|
|
|
14168
14590
|
"ves.io.schema.rules.string.max_len": "256",
|
|
14169
14591
|
"ves.io.schema.rules.string.min_len": "1"
|
|
14170
14592
|
},
|
|
14593
|
+
"x-f5xc-description-short": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
14594
|
+
"x-f5xc-description-medium": "Name given to this secret management backend. site.provider needs to be unique, and will be referenced for using this object Required: YES.",
|
|
14171
14595
|
"x-f5xc-required-for": {
|
|
14172
14596
|
"minimum_config": false,
|
|
14173
14597
|
"create": false,
|
|
@@ -14179,6 +14603,8 @@
|
|
|
14179
14603
|
"$ref": "#/components/schemas/schemaNetworkSiteRefSelector"
|
|
14180
14604
|
}
|
|
14181
14605
|
},
|
|
14606
|
+
"x-f5xc-description-short": "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
|
|
14607
|
+
"x-f5xc-description-medium": "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
|
|
14182
14608
|
"x-f5xc-minimum-configuration": {
|
|
14183
14609
|
"description": "Minimum configuration for secret_management_accessReplaceSpecType",
|
|
14184
14610
|
"required_fields": [
|
|
@@ -14234,6 +14660,7 @@
|
|
|
14234
14660
|
}
|
|
14235
14661
|
}
|
|
14236
14662
|
},
|
|
14663
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
14237
14664
|
"x-f5xc-minimum-configuration": {
|
|
14238
14665
|
"description": "Minimum configuration for secret_management_accessStatusObject",
|
|
14239
14666
|
"required_fields": [
|
|
@@ -14262,6 +14689,8 @@
|
|
|
14262
14689
|
"x-displayname": "Kind",
|
|
14263
14690
|
"x-ves-example": "Virtual_site.",
|
|
14264
14691
|
"x-f5xc-example": "virtual_site",
|
|
14692
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")",
|
|
14693
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").",
|
|
14265
14694
|
"minLength": 0,
|
|
14266
14695
|
"maxLength": 14,
|
|
14267
14696
|
"x-f5xc-required-for": {
|
|
@@ -14273,7 +14702,7 @@
|
|
|
14273
14702
|
"readOnly": true,
|
|
14274
14703
|
"x-original-maxLength": 1024,
|
|
14275
14704
|
"x-reconciled-from-discovery": true,
|
|
14276
|
-
"x-reconciled-at": "2026-01-
|
|
14705
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917201+00:00"
|
|
14277
14706
|
},
|
|
14278
14707
|
"name": {
|
|
14279
14708
|
"type": "string",
|
|
@@ -14282,6 +14711,8 @@
|
|
|
14282
14711
|
"x-displayname": "Name",
|
|
14283
14712
|
"x-ves-example": "Contactus-route.",
|
|
14284
14713
|
"x-f5xc-example": "contactus-route",
|
|
14714
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.",
|
|
14715
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.",
|
|
14285
14716
|
"minLength": 0,
|
|
14286
14717
|
"maxLength": 16,
|
|
14287
14718
|
"x-f5xc-required-for": {
|
|
@@ -14292,7 +14723,7 @@
|
|
|
14292
14723
|
},
|
|
14293
14724
|
"x-original-maxLength": 1024,
|
|
14294
14725
|
"x-reconciled-from-discovery": true,
|
|
14295
|
-
"x-reconciled-at": "2026-01-
|
|
14726
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917208+00:00"
|
|
14296
14727
|
},
|
|
14297
14728
|
"namespace": {
|
|
14298
14729
|
"type": "string",
|
|
@@ -14301,6 +14732,8 @@
|
|
|
14301
14732
|
"x-displayname": "Namespace",
|
|
14302
14733
|
"x-ves-example": "Ns1",
|
|
14303
14734
|
"x-f5xc-example": "ns1",
|
|
14735
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.",
|
|
14736
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.",
|
|
14304
14737
|
"minLength": 0,
|
|
14305
14738
|
"maxLength": 6,
|
|
14306
14739
|
"x-f5xc-required-for": {
|
|
@@ -14311,7 +14744,7 @@
|
|
|
14311
14744
|
},
|
|
14312
14745
|
"x-original-maxLength": 1024,
|
|
14313
14746
|
"x-reconciled-from-discovery": true,
|
|
14314
|
-
"x-reconciled-at": "2026-01-
|
|
14747
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917213+00:00"
|
|
14315
14748
|
},
|
|
14316
14749
|
"tenant": {
|
|
14317
14750
|
"type": "string",
|
|
@@ -14320,6 +14753,8 @@
|
|
|
14320
14753
|
"x-displayname": "Tenant",
|
|
14321
14754
|
"x-ves-example": "Example-corp.",
|
|
14322
14755
|
"x-f5xc-example": "example-corp",
|
|
14756
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.",
|
|
14757
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.",
|
|
14323
14758
|
"minLength": 0,
|
|
14324
14759
|
"maxLength": 18,
|
|
14325
14760
|
"x-f5xc-required-for": {
|
|
@@ -14332,7 +14767,7 @@
|
|
|
14332
14767
|
"x-field-mutability": "read-only",
|
|
14333
14768
|
"x-original-maxLength": 1024,
|
|
14334
14769
|
"x-reconciled-from-discovery": true,
|
|
14335
|
-
"x-reconciled-at": "2026-01-
|
|
14770
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917218+00:00"
|
|
14336
14771
|
},
|
|
14337
14772
|
"uid": {
|
|
14338
14773
|
"type": "string",
|
|
@@ -14341,6 +14776,8 @@
|
|
|
14341
14776
|
"x-displayname": "UID",
|
|
14342
14777
|
"x-ves-example": "D15f1fad-4d37-48c0-8706-df1824d76d31.",
|
|
14343
14778
|
"x-f5xc-example": "d15f1fad-4d37-48c0-8706-df1824d76d31",
|
|
14779
|
+
"x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.",
|
|
14780
|
+
"x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.",
|
|
14344
14781
|
"minLength": 0,
|
|
14345
14782
|
"maxLength": 36,
|
|
14346
14783
|
"x-f5xc-required-for": {
|
|
@@ -14354,9 +14791,11 @@
|
|
|
14354
14791
|
"x-original-maxLength": 1024,
|
|
14355
14792
|
"format": "uuid",
|
|
14356
14793
|
"x-reconciled-from-discovery": true,
|
|
14357
|
-
"x-reconciled-at": "2026-01-
|
|
14794
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917224+00:00"
|
|
14358
14795
|
}
|
|
14359
14796
|
},
|
|
14797
|
+
"x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).",
|
|
14798
|
+
"x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...",
|
|
14360
14799
|
"x-f5xc-minimum-configuration": {
|
|
14361
14800
|
"description": "Minimum configuration for ioschemaObjectRefType",
|
|
14362
14801
|
"required_fields": [
|
|
@@ -14403,7 +14842,7 @@
|
|
|
14403
14842
|
},
|
|
14404
14843
|
"x-original-maxLength": 256,
|
|
14405
14844
|
"x-reconciled-from-discovery": true,
|
|
14406
|
-
"x-reconciled-at": "2026-01-
|
|
14845
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917312+00:00"
|
|
14407
14846
|
},
|
|
14408
14847
|
"name": {
|
|
14409
14848
|
"type": "string",
|
|
@@ -14424,6 +14863,7 @@
|
|
|
14424
14863
|
"ves.io.schema.rules.string.min_len": "1",
|
|
14425
14864
|
"ves.io.schema.rules.string.ves_object_name": "true"
|
|
14426
14865
|
},
|
|
14866
|
+
"x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.",
|
|
14427
14867
|
"maxLength": 16,
|
|
14428
14868
|
"x-f5xc-required-for": {
|
|
14429
14869
|
"minimum_config": false,
|
|
@@ -14433,9 +14873,11 @@
|
|
|
14433
14873
|
},
|
|
14434
14874
|
"x-original-maxLength": 1024,
|
|
14435
14875
|
"x-reconciled-from-discovery": true,
|
|
14436
|
-
"x-reconciled-at": "2026-01-
|
|
14876
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917317+00:00"
|
|
14437
14877
|
}
|
|
14438
14878
|
},
|
|
14879
|
+
"x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.",
|
|
14880
|
+
"x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...",
|
|
14439
14881
|
"x-f5xc-minimum-configuration": {
|
|
14440
14882
|
"description": "Minimum configuration for schemaMessageMetaType",
|
|
14441
14883
|
"required_fields": [
|
|
@@ -14464,6 +14906,8 @@
|
|
|
14464
14906
|
"x-displayname": "Allow F5XC.",
|
|
14465
14907
|
"x-ves-example": "True",
|
|
14466
14908
|
"x-f5xc-example": "true",
|
|
14909
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14910
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14467
14911
|
"x-f5xc-required-for": {
|
|
14468
14912
|
"minimum_config": false,
|
|
14469
14913
|
"create": false,
|
|
@@ -14477,6 +14921,8 @@
|
|
|
14477
14921
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14478
14922
|
"x-ves-example": "6h",
|
|
14479
14923
|
"x-f5xc-example": "6h",
|
|
14924
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
14925
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14480
14926
|
"minLength": 0,
|
|
14481
14927
|
"maxLength": 1024,
|
|
14482
14928
|
"x-f5xc-required-for": {
|
|
@@ -14490,6 +14936,7 @@
|
|
|
14490
14936
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14491
14937
|
}
|
|
14492
14938
|
},
|
|
14939
|
+
"x-f5xc-description-short": "Create secret_policy creates a new object in the storage backend for metadata.namespace.",
|
|
14493
14940
|
"x-f5xc-minimum-configuration": {
|
|
14494
14941
|
"description": "Minimum configuration for schemasecret_policyCreateSpecType",
|
|
14495
14942
|
"required_fields": [
|
|
@@ -14519,6 +14966,8 @@
|
|
|
14519
14966
|
"x-displayname": "Allow F5XC.",
|
|
14520
14967
|
"x-ves-example": "True",
|
|
14521
14968
|
"x-f5xc-example": "true",
|
|
14969
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14970
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14522
14971
|
"x-f5xc-required-for": {
|
|
14523
14972
|
"minimum_config": false,
|
|
14524
14973
|
"create": false,
|
|
@@ -14532,6 +14981,8 @@
|
|
|
14532
14981
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14533
14982
|
"x-ves-example": "6h",
|
|
14534
14983
|
"x-f5xc-example": "6h",
|
|
14984
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
14985
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14535
14986
|
"minLength": 0,
|
|
14536
14987
|
"maxLength": 1024,
|
|
14537
14988
|
"x-f5xc-required-for": {
|
|
@@ -14547,6 +14998,8 @@
|
|
|
14547
14998
|
"title": "Deletion Time.",
|
|
14548
14999
|
"format": "date-time",
|
|
14549
15000
|
"x-displayname": "Deletion Time.",
|
|
15001
|
+
"x-f5xc-description-short": "Deletion_time is set when the secret policy object is marked for DELETE, secret policy marked for DELETE will be automatically deleted after...",
|
|
15002
|
+
"x-f5xc-description-medium": "Deletion_time is set when the secret policy object is marked for DELETE, secret policy marked for DELETE will be automatically deleted after deletion_time.",
|
|
14550
15003
|
"minLength": 0,
|
|
14551
15004
|
"maxLength": 1024,
|
|
14552
15005
|
"x-f5xc-required-for": {
|
|
@@ -14565,6 +15018,8 @@
|
|
|
14565
15018
|
"title": "Marked For DELETE.",
|
|
14566
15019
|
"format": "boolean",
|
|
14567
15020
|
"x-displayname": "Marked For DELETE.",
|
|
15021
|
+
"x-f5xc-description-short": "Marked_for_delete is set when the secret policy object is marked for DELETE, based on this value secret policy marked for DELETE will be...",
|
|
15022
|
+
"x-f5xc-description-medium": "Marked_for_delete is set when the secret policy object is marked for DELETE, based on this value secret policy marked for DELETE will be automatically deleted after deletion_time.",
|
|
14568
15023
|
"x-f5xc-required-for": {
|
|
14569
15024
|
"minimum_config": false,
|
|
14570
15025
|
"create": false,
|
|
@@ -14576,6 +15031,7 @@
|
|
|
14576
15031
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14577
15032
|
}
|
|
14578
15033
|
},
|
|
15034
|
+
"x-f5xc-description-short": "GET secret_policy reads a given object from storage backend for metadata.namespace.",
|
|
14579
15035
|
"x-f5xc-minimum-configuration": {
|
|
14580
15036
|
"description": "Minimum configuration for schemasecret_policyGetSpecType",
|
|
14581
15037
|
"required_fields": [
|
|
@@ -14608,6 +15064,8 @@
|
|
|
14608
15064
|
"x-displayname": "Allow F5XC.",
|
|
14609
15065
|
"x-ves-example": "True",
|
|
14610
15066
|
"x-f5xc-example": "true",
|
|
15067
|
+
"x-f5xc-description-short": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
15068
|
+
"x-f5xc-description-medium": "If allow_f5xc is set to true, it allows relevant F5XC infrastructure services to decrypt the secret encrypted using this policy.",
|
|
14611
15069
|
"x-f5xc-required-for": {
|
|
14612
15070
|
"minimum_config": false,
|
|
14613
15071
|
"create": false,
|
|
@@ -14621,6 +15079,8 @@
|
|
|
14621
15079
|
"x-displayname": "Decrypt Cache Timeout.",
|
|
14622
15080
|
"x-ves-example": "6h",
|
|
14623
15081
|
"x-f5xc-example": "6h",
|
|
15082
|
+
"x-f5xc-description-short": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman.",
|
|
15083
|
+
"x-f5xc-description-medium": "Decrypt_cache_timeout contains the amount of time a decrypted secret is cached in wingman. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
14624
15084
|
"minLength": 0,
|
|
14625
15085
|
"maxLength": 1024,
|
|
14626
15086
|
"x-f5xc-required-for": {
|
|
@@ -14637,6 +15097,7 @@
|
|
|
14637
15097
|
"$ref": "#/components/schemas/secret_policyRuleList"
|
|
14638
15098
|
}
|
|
14639
15099
|
},
|
|
15100
|
+
"x-f5xc-description-short": "Replace secret_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
14640
15101
|
"x-f5xc-minimum-configuration": {
|
|
14641
15102
|
"description": "Minimum configuration for schemasecret_policyReplaceSpecType",
|
|
14642
15103
|
"required_fields": [
|
|
@@ -14720,6 +15181,7 @@
|
|
|
14720
15181
|
"title": "Fail_if_referred.",
|
|
14721
15182
|
"format": "boolean",
|
|
14722
15183
|
"x-displayname": "Fail-If-Referred.",
|
|
15184
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
14723
15185
|
"x-f5xc-required-for": {
|
|
14724
15186
|
"minimum_config": false,
|
|
14725
15187
|
"create": false,
|
|
@@ -14744,7 +15206,7 @@
|
|
|
14744
15206
|
},
|
|
14745
15207
|
"x-original-maxLength": 1024,
|
|
14746
15208
|
"x-reconciled-from-discovery": true,
|
|
14747
|
-
"x-reconciled-at": "2026-01-
|
|
15209
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917495+00:00"
|
|
14748
15210
|
},
|
|
14749
15211
|
"namespace": {
|
|
14750
15212
|
"type": "string",
|
|
@@ -14753,6 +15215,7 @@
|
|
|
14753
15215
|
"x-displayname": "Namespace",
|
|
14754
15216
|
"x-ves-example": "Ns1",
|
|
14755
15217
|
"x-f5xc-example": "ns1",
|
|
15218
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
14756
15219
|
"minLength": 0,
|
|
14757
15220
|
"maxLength": 6,
|
|
14758
15221
|
"x-f5xc-required-for": {
|
|
@@ -14763,7 +15226,7 @@
|
|
|
14763
15226
|
},
|
|
14764
15227
|
"x-original-maxLength": 1024,
|
|
14765
15228
|
"x-reconciled-from-discovery": true,
|
|
14766
|
-
"x-reconciled-at": "2026-01-
|
|
15229
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917500+00:00"
|
|
14767
15230
|
}
|
|
14768
15231
|
},
|
|
14769
15232
|
"x-f5xc-minimum-configuration": {
|
|
@@ -14798,6 +15261,7 @@
|
|
|
14798
15261
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14799
15262
|
},
|
|
14800
15263
|
"x-displayname": "Deleted Referred Objects.",
|
|
15264
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14801
15265
|
"x-f5xc-required-for": {
|
|
14802
15266
|
"minimum_config": false,
|
|
14803
15267
|
"create": false,
|
|
@@ -14813,6 +15277,7 @@
|
|
|
14813
15277
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14814
15278
|
},
|
|
14815
15279
|
"x-displayname": "Disabled Referred Objects.",
|
|
15280
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
14816
15281
|
"x-f5xc-required-for": {
|
|
14817
15282
|
"minimum_config": false,
|
|
14818
15283
|
"create": false,
|
|
@@ -14831,6 +15296,7 @@
|
|
|
14831
15296
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
14832
15297
|
},
|
|
14833
15298
|
"x-displayname": "Referring Objects.",
|
|
15299
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
14834
15300
|
"x-f5xc-required-for": {
|
|
14835
15301
|
"minimum_config": false,
|
|
14836
15302
|
"create": false,
|
|
@@ -14852,6 +15318,8 @@
|
|
|
14852
15318
|
"$ref": "#/components/schemas/secret_policyStatusObject"
|
|
14853
15319
|
},
|
|
14854
15320
|
"x-displayname": "Status",
|
|
15321
|
+
"x-f5xc-example": "active",
|
|
15322
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
14855
15323
|
"x-f5xc-required-for": {
|
|
14856
15324
|
"minimum_config": false,
|
|
14857
15325
|
"create": false,
|
|
@@ -14861,7 +15329,7 @@
|
|
|
14861
15329
|
"maxLength": 17,
|
|
14862
15330
|
"minLength": 17,
|
|
14863
15331
|
"x-reconciled-from-discovery": true,
|
|
14864
|
-
"x-reconciled-at": "2026-01-
|
|
15332
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917514+00:00"
|
|
14865
15333
|
},
|
|
14866
15334
|
"system_metadata": {
|
|
14867
15335
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -14901,6 +15369,8 @@
|
|
|
14901
15369
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
14902
15370
|
],
|
|
14903
15371
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
15372
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
15373
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
14904
15374
|
"x-f5xc-minimum-configuration": {
|
|
14905
15375
|
"description": "Minimum configuration for secret_policyGetResponseFormatCode",
|
|
14906
15376
|
"required_fields": [],
|
|
@@ -14933,6 +15403,9 @@
|
|
|
14933
15403
|
"x-validation-rules": {
|
|
14934
15404
|
"ves.io.schema.rules.repeated.max_items": "256"
|
|
14935
15405
|
},
|
|
15406
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15407
|
+
"x-f5xc-description-short": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15408
|
+
"x-f5xc-description-medium": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
14936
15409
|
"x-f5xc-required-for": {
|
|
14937
15410
|
"minimum_config": false,
|
|
14938
15411
|
"create": false,
|
|
@@ -14941,6 +15414,8 @@
|
|
|
14941
15414
|
}
|
|
14942
15415
|
}
|
|
14943
15416
|
},
|
|
15417
|
+
"x-f5xc-description-short": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15418
|
+
"x-f5xc-description-medium": "List of references to service_policy_rule objects. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
14944
15419
|
"x-f5xc-minimum-configuration": {
|
|
14945
15420
|
"description": "Minimum configuration for secret_policyLegacyRuleList",
|
|
14946
15421
|
"required_fields": [
|
|
@@ -14968,6 +15443,7 @@
|
|
|
14968
15443
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
14969
15444
|
},
|
|
14970
15445
|
"x-displayname": "Errors",
|
|
15446
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
14971
15447
|
"x-f5xc-required-for": {
|
|
14972
15448
|
"minimum_config": false,
|
|
14973
15449
|
"create": false,
|
|
@@ -14983,6 +15459,8 @@
|
|
|
14983
15459
|
"$ref": "#/components/schemas/secret_policyListPolicyResponseItem"
|
|
14984
15460
|
},
|
|
14985
15461
|
"x-displayname": "Items",
|
|
15462
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15463
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
14986
15464
|
"x-f5xc-required-for": {
|
|
14987
15465
|
"minimum_config": false,
|
|
14988
15466
|
"create": false,
|
|
@@ -14991,6 +15469,7 @@
|
|
|
14991
15469
|
}
|
|
14992
15470
|
}
|
|
14993
15471
|
},
|
|
15472
|
+
"x-f5xc-description-short": "Response message of the 'ListPolicy' RPC.",
|
|
14994
15473
|
"x-f5xc-minimum-configuration": {
|
|
14995
15474
|
"description": "Minimum configuration for secret_policyListPolicyResponse",
|
|
14996
15475
|
"required_fields": [
|
|
@@ -15015,6 +15494,8 @@
|
|
|
15015
15494
|
"description": "The set of annotations present on this secret_policy.",
|
|
15016
15495
|
"title": "Annotations.",
|
|
15017
15496
|
"x-displayname": "Annotations.",
|
|
15497
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15498
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy.",
|
|
15018
15499
|
"x-f5xc-required-for": {
|
|
15019
15500
|
"minimum_config": false,
|
|
15020
15501
|
"create": false,
|
|
@@ -15027,6 +15508,7 @@
|
|
|
15027
15508
|
"description": "The description set for this secret_policy.",
|
|
15028
15509
|
"title": "Description.",
|
|
15029
15510
|
"x-displayname": "Description.",
|
|
15511
|
+
"x-f5xc-description-short": "The description set for this secret_policy.",
|
|
15030
15512
|
"minLength": 0,
|
|
15031
15513
|
"maxLength": 0,
|
|
15032
15514
|
"x-f5xc-required-for": {
|
|
@@ -15037,7 +15519,7 @@
|
|
|
15037
15519
|
},
|
|
15038
15520
|
"x-original-maxLength": 1024,
|
|
15039
15521
|
"x-reconciled-from-discovery": true,
|
|
15040
|
-
"x-reconciled-at": "2026-01-
|
|
15522
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917529+00:00"
|
|
15041
15523
|
},
|
|
15042
15524
|
"disabled": {
|
|
15043
15525
|
"type": "boolean",
|
|
@@ -15045,6 +15527,8 @@
|
|
|
15045
15527
|
"title": "Disabled",
|
|
15046
15528
|
"format": "boolean",
|
|
15047
15529
|
"x-displayname": "Disabled",
|
|
15530
|
+
"x-f5xc-example": "True",
|
|
15531
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy is administratively disabled.",
|
|
15048
15532
|
"x-f5xc-required-for": {
|
|
15049
15533
|
"minimum_config": false,
|
|
15050
15534
|
"create": false,
|
|
@@ -15060,6 +15544,8 @@
|
|
|
15060
15544
|
"description": "The set of labels present on this secret_policy.",
|
|
15061
15545
|
"title": "Labels",
|
|
15062
15546
|
"x-displayname": "Labels",
|
|
15547
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15548
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy.",
|
|
15063
15549
|
"x-f5xc-required-for": {
|
|
15064
15550
|
"minimum_config": false,
|
|
15065
15551
|
"create": false,
|
|
@@ -15087,7 +15573,7 @@
|
|
|
15087
15573
|
},
|
|
15088
15574
|
"x-original-maxLength": 1024,
|
|
15089
15575
|
"x-reconciled-from-discovery": true,
|
|
15090
|
-
"x-reconciled-at": "2026-01-
|
|
15576
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917539+00:00"
|
|
15091
15577
|
},
|
|
15092
15578
|
"namespace": {
|
|
15093
15579
|
"type": "string",
|
|
@@ -15106,7 +15592,7 @@
|
|
|
15106
15592
|
},
|
|
15107
15593
|
"x-original-maxLength": 1024,
|
|
15108
15594
|
"x-reconciled-from-discovery": true,
|
|
15109
|
-
"x-reconciled-at": "2026-01-
|
|
15595
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917544+00:00"
|
|
15110
15596
|
},
|
|
15111
15597
|
"system_metadata": {
|
|
15112
15598
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -15129,7 +15615,7 @@
|
|
|
15129
15615
|
"x-field-mutability": "read-only",
|
|
15130
15616
|
"x-original-maxLength": 1024,
|
|
15131
15617
|
"x-reconciled-from-discovery": true,
|
|
15132
|
-
"x-reconciled-at": "2026-01-
|
|
15618
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917551+00:00"
|
|
15133
15619
|
},
|
|
15134
15620
|
"uid": {
|
|
15135
15621
|
"type": "string",
|
|
@@ -15150,7 +15636,7 @@
|
|
|
15150
15636
|
"x-original-maxLength": 1024,
|
|
15151
15637
|
"format": "uuid",
|
|
15152
15638
|
"x-reconciled-from-discovery": true,
|
|
15153
|
-
"x-reconciled-at": "2026-01-
|
|
15639
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917578+00:00"
|
|
15154
15640
|
}
|
|
15155
15641
|
},
|
|
15156
15642
|
"x-f5xc-minimum-configuration": {
|
|
@@ -15190,6 +15676,7 @@
|
|
|
15190
15676
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
15191
15677
|
},
|
|
15192
15678
|
"x-displayname": "Errors",
|
|
15679
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
15193
15680
|
"x-f5xc-required-for": {
|
|
15194
15681
|
"minimum_config": false,
|
|
15195
15682
|
"create": false,
|
|
@@ -15205,6 +15692,8 @@
|
|
|
15205
15692
|
"$ref": "#/components/schemas/secret_policyListResponseItem"
|
|
15206
15693
|
},
|
|
15207
15694
|
"x-displayname": "Items",
|
|
15695
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
15696
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
15208
15697
|
"x-f5xc-required-for": {
|
|
15209
15698
|
"minimum_config": false,
|
|
15210
15699
|
"create": false,
|
|
@@ -15238,6 +15727,8 @@
|
|
|
15238
15727
|
"description": "The set of annotations present on this secret_policy.",
|
|
15239
15728
|
"title": "Annotations.",
|
|
15240
15729
|
"x-displayname": "Annotations.",
|
|
15730
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15731
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy.",
|
|
15241
15732
|
"x-f5xc-required-for": {
|
|
15242
15733
|
"minimum_config": false,
|
|
15243
15734
|
"create": false,
|
|
@@ -15250,6 +15741,7 @@
|
|
|
15250
15741
|
"description": "The description set for this secret_policy.",
|
|
15251
15742
|
"title": "Description.",
|
|
15252
15743
|
"x-displayname": "Description.",
|
|
15744
|
+
"x-f5xc-description-short": "The description set for this secret_policy.",
|
|
15253
15745
|
"minLength": 0,
|
|
15254
15746
|
"maxLength": 0,
|
|
15255
15747
|
"x-f5xc-required-for": {
|
|
@@ -15260,7 +15752,7 @@
|
|
|
15260
15752
|
},
|
|
15261
15753
|
"x-original-maxLength": 1024,
|
|
15262
15754
|
"x-reconciled-from-discovery": true,
|
|
15263
|
-
"x-reconciled-at": "2026-01-
|
|
15755
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917588+00:00"
|
|
15264
15756
|
},
|
|
15265
15757
|
"disabled": {
|
|
15266
15758
|
"type": "boolean",
|
|
@@ -15268,6 +15760,8 @@
|
|
|
15268
15760
|
"title": "Disabled",
|
|
15269
15761
|
"format": "boolean",
|
|
15270
15762
|
"x-displayname": "Disabled",
|
|
15763
|
+
"x-f5xc-example": "True",
|
|
15764
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy is administratively disabled.",
|
|
15271
15765
|
"x-f5xc-required-for": {
|
|
15272
15766
|
"minimum_config": false,
|
|
15273
15767
|
"create": false,
|
|
@@ -15283,6 +15777,8 @@
|
|
|
15283
15777
|
"description": "The set of labels present on this secret_policy.",
|
|
15284
15778
|
"title": "Labels",
|
|
15285
15779
|
"x-displayname": "Labels",
|
|
15780
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
15781
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy.",
|
|
15286
15782
|
"x-f5xc-required-for": {
|
|
15287
15783
|
"minimum_config": false,
|
|
15288
15784
|
"create": false,
|
|
@@ -15310,7 +15806,7 @@
|
|
|
15310
15806
|
},
|
|
15311
15807
|
"x-original-maxLength": 1024,
|
|
15312
15808
|
"x-reconciled-from-discovery": true,
|
|
15313
|
-
"x-reconciled-at": "2026-01-
|
|
15809
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917599+00:00"
|
|
15314
15810
|
},
|
|
15315
15811
|
"namespace": {
|
|
15316
15812
|
"type": "string",
|
|
@@ -15329,7 +15825,7 @@
|
|
|
15329
15825
|
},
|
|
15330
15826
|
"x-original-maxLength": 1024,
|
|
15331
15827
|
"x-reconciled-from-discovery": true,
|
|
15332
|
-
"x-reconciled-at": "2026-01-
|
|
15828
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917603+00:00"
|
|
15333
15829
|
},
|
|
15334
15830
|
"owner_view": {
|
|
15335
15831
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -15342,6 +15838,7 @@
|
|
|
15342
15838
|
"$ref": "#/components/schemas/secret_policyStatusObject"
|
|
15343
15839
|
},
|
|
15344
15840
|
"x-displayname": "Status",
|
|
15841
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
15345
15842
|
"x-f5xc-required-for": {
|
|
15346
15843
|
"minimum_config": false,
|
|
15347
15844
|
"create": false,
|
|
@@ -15370,7 +15867,7 @@
|
|
|
15370
15867
|
"x-field-mutability": "read-only",
|
|
15371
15868
|
"x-original-maxLength": 1024,
|
|
15372
15869
|
"x-reconciled-from-discovery": true,
|
|
15373
|
-
"x-reconciled-at": "2026-01-
|
|
15870
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917610+00:00"
|
|
15374
15871
|
},
|
|
15375
15872
|
"uid": {
|
|
15376
15873
|
"type": "string",
|
|
@@ -15391,9 +15888,11 @@
|
|
|
15391
15888
|
"x-original-maxLength": 1024,
|
|
15392
15889
|
"format": "uuid",
|
|
15393
15890
|
"x-reconciled-from-discovery": true,
|
|
15394
|
-
"x-reconciled-at": "2026-01-
|
|
15891
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917615+00:00"
|
|
15395
15892
|
}
|
|
15396
15893
|
},
|
|
15894
|
+
"x-f5xc-description-short": "By default a summary of secret_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15895
|
+
"x-f5xc-description-medium": "By default a summary of secret_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
15397
15896
|
"x-f5xc-minimum-configuration": {
|
|
15398
15897
|
"description": "Minimum configuration for secret_policyListResponseItem",
|
|
15399
15898
|
"required_fields": [
|
|
@@ -15439,6 +15938,7 @@
|
|
|
15439
15938
|
"x-validation-rules": {
|
|
15440
15939
|
"ves.io.schema.rules.message.required": "true"
|
|
15441
15940
|
},
|
|
15941
|
+
"x-f5xc-description-short": "Name of the secret policy Required: YES.",
|
|
15442
15942
|
"minLength": 0,
|
|
15443
15943
|
"maxLength": 16,
|
|
15444
15944
|
"x-f5xc-required-for": {
|
|
@@ -15449,7 +15949,7 @@
|
|
|
15449
15949
|
},
|
|
15450
15950
|
"x-original-maxLength": 1024,
|
|
15451
15951
|
"x-reconciled-from-discovery": true,
|
|
15452
|
-
"x-reconciled-at": "2026-01-
|
|
15952
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917620+00:00"
|
|
15453
15953
|
},
|
|
15454
15954
|
"namespace": {
|
|
15455
15955
|
"type": "string",
|
|
@@ -15465,6 +15965,7 @@
|
|
|
15465
15965
|
"x-validation-rules": {
|
|
15466
15966
|
"ves.io.schema.rules.message.required": "true"
|
|
15467
15967
|
},
|
|
15968
|
+
"x-f5xc-description-short": "Namespace of the secret policy Required: YES.",
|
|
15468
15969
|
"minLength": 0,
|
|
15469
15970
|
"maxLength": 6,
|
|
15470
15971
|
"x-f5xc-required-for": {
|
|
@@ -15475,9 +15976,10 @@
|
|
|
15475
15976
|
},
|
|
15476
15977
|
"x-original-maxLength": 1024,
|
|
15477
15978
|
"x-reconciled-from-discovery": true,
|
|
15478
|
-
"x-reconciled-at": "2026-01-
|
|
15979
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917624+00:00"
|
|
15479
15980
|
}
|
|
15480
15981
|
},
|
|
15982
|
+
"x-f5xc-description-short": "Input message of the 'RecoverPolicy' RPC.",
|
|
15481
15983
|
"x-f5xc-minimum-configuration": {
|
|
15482
15984
|
"description": "Minimum configuration for secret_policyRecoverRequest",
|
|
15483
15985
|
"required_fields": [
|
|
@@ -15515,9 +16017,10 @@
|
|
|
15515
16017
|
},
|
|
15516
16018
|
"x-original-maxLength": 1024,
|
|
15517
16019
|
"x-reconciled-from-discovery": true,
|
|
15518
|
-
"x-reconciled-at": "2026-01-
|
|
16020
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917629+00:00"
|
|
15519
16021
|
}
|
|
15520
16022
|
},
|
|
16023
|
+
"x-f5xc-description-short": "Response message of the 'RecoverPolicy' RPC.",
|
|
15521
16024
|
"x-f5xc-minimum-configuration": {
|
|
15522
16025
|
"description": "Minimum configuration for secret_policyRecoverResponse",
|
|
15523
16026
|
"required_fields": [
|
|
@@ -15584,6 +16087,8 @@
|
|
|
15584
16087
|
"$ref": "#/components/schemas/schemasecret_policy_ruleGlobalSpecType"
|
|
15585
16088
|
}
|
|
15586
16089
|
},
|
|
16090
|
+
"x-f5xc-description-short": "Rule consists of an unordered list of predicates and an action.",
|
|
16091
|
+
"x-f5xc-description-medium": "Rule consists of an unordered list of predicates and an action. The predicates are evaluated against a set of input fields that are extracted from or derived from an L7 request API. A request API is considered to match the simple rule if all predicates in the rule evaluate to true for that request.",
|
|
15587
16092
|
"x-f5xc-minimum-configuration": {
|
|
15588
16093
|
"description": "Minimum configuration for secret_policyRule",
|
|
15589
16094
|
"required_fields": [
|
|
@@ -15621,6 +16126,9 @@
|
|
|
15621
16126
|
"ves.io.schema.rules.repeated.max_items": "256",
|
|
15622
16127
|
"ves.io.schema.rules.repeated.unique_metadata_name": "true"
|
|
15623
16128
|
},
|
|
16129
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16130
|
+
"x-f5xc-description-short": "Define the list of rules (with an order) that should be evaluated by this service policy.",
|
|
16131
|
+
"x-f5xc-description-medium": "Define the list of rules (with an order) that should be evaluated by this service policy. Rules are evaluated from top to bottom in the list.",
|
|
15624
16132
|
"x-f5xc-required-for": {
|
|
15625
16133
|
"minimum_config": false,
|
|
15626
16134
|
"create": false,
|
|
@@ -15629,6 +16137,7 @@
|
|
|
15629
16137
|
}
|
|
15630
16138
|
}
|
|
15631
16139
|
},
|
|
16140
|
+
"x-f5xc-description-short": "List of rules. The order of evaluation of the rules depends on the rule combining algorithm.",
|
|
15632
16141
|
"x-f5xc-minimum-configuration": {
|
|
15633
16142
|
"description": "Minimum configuration for secret_policyRuleList",
|
|
15634
16143
|
"required_fields": [
|
|
@@ -15662,6 +16171,7 @@
|
|
|
15662
16171
|
"x-validation-rules": {
|
|
15663
16172
|
"ves.io.schema.rules.message.required": "true"
|
|
15664
16173
|
},
|
|
16174
|
+
"x-f5xc-description-short": "Name of the secret policy Required: YES.",
|
|
15665
16175
|
"minLength": 0,
|
|
15666
16176
|
"maxLength": 16,
|
|
15667
16177
|
"x-f5xc-required-for": {
|
|
@@ -15672,7 +16182,7 @@
|
|
|
15672
16182
|
},
|
|
15673
16183
|
"x-original-maxLength": 1024,
|
|
15674
16184
|
"x-reconciled-from-discovery": true,
|
|
15675
|
-
"x-reconciled-at": "2026-01-
|
|
16185
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917642+00:00"
|
|
15676
16186
|
},
|
|
15677
16187
|
"namespace": {
|
|
15678
16188
|
"type": "string",
|
|
@@ -15688,6 +16198,7 @@
|
|
|
15688
16198
|
"x-validation-rules": {
|
|
15689
16199
|
"ves.io.schema.rules.message.required": "true"
|
|
15690
16200
|
},
|
|
16201
|
+
"x-f5xc-description-short": "Namespace of the secret policy Required: YES.",
|
|
15691
16202
|
"minLength": 0,
|
|
15692
16203
|
"maxLength": 6,
|
|
15693
16204
|
"x-f5xc-required-for": {
|
|
@@ -15698,9 +16209,10 @@
|
|
|
15698
16209
|
},
|
|
15699
16210
|
"x-original-maxLength": 1024,
|
|
15700
16211
|
"x-reconciled-from-discovery": true,
|
|
15701
|
-
"x-reconciled-at": "2026-01-
|
|
16212
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917646+00:00"
|
|
15702
16213
|
}
|
|
15703
16214
|
},
|
|
16215
|
+
"x-f5xc-description-short": "Input message of the 'DeletePolicy' RPC.",
|
|
15704
16216
|
"x-f5xc-minimum-configuration": {
|
|
15705
16217
|
"description": "Minimum configuration for secret_policySoftDeleteRequest",
|
|
15706
16218
|
"required_fields": [
|
|
@@ -15738,9 +16250,10 @@
|
|
|
15738
16250
|
},
|
|
15739
16251
|
"x-original-maxLength": 1024,
|
|
15740
16252
|
"x-reconciled-from-discovery": true,
|
|
15741
|
-
"x-reconciled-at": "2026-01-
|
|
16253
|
+
"x-reconciled-at": "2026-01-07T15:53:57.917651+00:00"
|
|
15742
16254
|
}
|
|
15743
16255
|
},
|
|
16256
|
+
"x-f5xc-description-short": "Response message of the 'DeletePolicy' RPC.",
|
|
15744
16257
|
"x-f5xc-minimum-configuration": {
|
|
15745
16258
|
"description": "Minimum configuration for secret_policySoftDeleteResponse",
|
|
15746
16259
|
"required_fields": [
|
|
@@ -15794,6 +16307,7 @@
|
|
|
15794
16307
|
}
|
|
15795
16308
|
}
|
|
15796
16309
|
},
|
|
16310
|
+
"x-f5xc-description-short": "Most recently observed status of the object.",
|
|
15797
16311
|
"x-f5xc-minimum-configuration": {
|
|
15798
16312
|
"description": "Minimum configuration for secret_policyStatusObject",
|
|
15799
16313
|
"required_fields": [
|
|
@@ -15839,6 +16353,7 @@
|
|
|
15839
16353
|
"ves.io.schema.rules.repeated.max_items": "64",
|
|
15840
16354
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
15841
16355
|
},
|
|
16356
|
+
"x-f5xc-description-short": "List of exact values to match the input against.",
|
|
15842
16357
|
"x-f5xc-required-for": {
|
|
15843
16358
|
"minimum_config": false,
|
|
15844
16359
|
"create": false,
|
|
@@ -15872,6 +16387,7 @@
|
|
|
15872
16387
|
"ves.io.schema.rules.repeated.max_items": "16",
|
|
15873
16388
|
"ves.io.schema.rules.repeated.unique": "true"
|
|
15874
16389
|
},
|
|
16390
|
+
"x-f5xc-description-short": "List of regular expressions to match the input against.",
|
|
15875
16391
|
"x-f5xc-required-for": {
|
|
15876
16392
|
"minimum_config": false,
|
|
15877
16393
|
"create": false,
|
|
@@ -15880,6 +16396,8 @@
|
|
|
15880
16396
|
}
|
|
15881
16397
|
}
|
|
15882
16398
|
},
|
|
16399
|
+
"x-f5xc-description-short": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied.",
|
|
16400
|
+
"x-f5xc-description-medium": "Matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set of supported match criteria includes a list of exact values and a list of regular expressions.",
|
|
15883
16401
|
"x-f5xc-minimum-configuration": {
|
|
15884
16402
|
"description": "Minimum configuration for policyMatcherTypeBasic",
|
|
15885
16403
|
"required_fields": [
|
|
@@ -15917,6 +16435,8 @@
|
|
|
15917
16435
|
"x-validation-rules": {
|
|
15918
16436
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
15919
16437
|
},
|
|
16438
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16439
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
15920
16440
|
"minLength": 0,
|
|
15921
16441
|
"x-f5xc-required-for": {
|
|
15922
16442
|
"minimum_config": false,
|
|
@@ -15932,6 +16452,7 @@
|
|
|
15932
16452
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
15933
16453
|
}
|
|
15934
16454
|
},
|
|
16455
|
+
"x-f5xc-description-short": "Create secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
15935
16456
|
"x-f5xc-minimum-configuration": {
|
|
15936
16457
|
"description": "Minimum configuration for schemasecret_policy_ruleCreateSpecType",
|
|
15937
16458
|
"required_fields": [
|
|
@@ -15971,6 +16492,8 @@
|
|
|
15971
16492
|
"x-validation-rules": {
|
|
15972
16493
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
15973
16494
|
},
|
|
16495
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16496
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
15974
16497
|
"minLength": 0,
|
|
15975
16498
|
"x-f5xc-required-for": {
|
|
15976
16499
|
"minimum_config": false,
|
|
@@ -15986,6 +16509,7 @@
|
|
|
15986
16509
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
15987
16510
|
}
|
|
15988
16511
|
},
|
|
16512
|
+
"x-f5xc-description-short": "GET secret_policy_rule reads a given object from storage backend for metadata.namespace.",
|
|
15989
16513
|
"x-f5xc-minimum-configuration": {
|
|
15990
16514
|
"description": "Minimum configuration for schemasecret_policy_ruleGetSpecType",
|
|
15991
16515
|
"required_fields": [
|
|
@@ -16025,6 +16549,8 @@
|
|
|
16025
16549
|
"x-validation-rules": {
|
|
16026
16550
|
"ves.io.schema.rules.string.max_bytes": "256"
|
|
16027
16551
|
},
|
|
16552
|
+
"x-f5xc-description-short": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret.",
|
|
16553
|
+
"x-f5xc-description-medium": "Exclusive with [client_name_matcher client_selector] The name of the client trying to access the secret. Name of the client will be extracted from client TLS certificate. This predicate evaluates to true if client name matches the configured name.",
|
|
16028
16554
|
"minLength": 0,
|
|
16029
16555
|
"x-f5xc-required-for": {
|
|
16030
16556
|
"minimum_config": false,
|
|
@@ -16040,6 +16566,7 @@
|
|
|
16040
16566
|
"$ref": "#/components/schemas/schemaLabelSelectorType"
|
|
16041
16567
|
}
|
|
16042
16568
|
},
|
|
16569
|
+
"x-f5xc-description-short": "Replace secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
16043
16570
|
"x-f5xc-minimum-configuration": {
|
|
16044
16571
|
"description": "Minimum configuration for schemasecret_policy_ruleReplaceSpecType",
|
|
16045
16572
|
"required_fields": [
|
|
@@ -16123,6 +16650,7 @@
|
|
|
16123
16650
|
"title": "Fail_if_referred.",
|
|
16124
16651
|
"format": "boolean",
|
|
16125
16652
|
"x-displayname": "Fail-If-Referred.",
|
|
16653
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
16126
16654
|
"x-f5xc-required-for": {
|
|
16127
16655
|
"minimum_config": false,
|
|
16128
16656
|
"create": false,
|
|
@@ -16147,7 +16675,7 @@
|
|
|
16147
16675
|
},
|
|
16148
16676
|
"x-original-maxLength": 1024,
|
|
16149
16677
|
"x-reconciled-from-discovery": true,
|
|
16150
|
-
"x-reconciled-at": "2026-01-
|
|
16678
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358780+00:00"
|
|
16151
16679
|
},
|
|
16152
16680
|
"namespace": {
|
|
16153
16681
|
"type": "string",
|
|
@@ -16156,6 +16684,7 @@
|
|
|
16156
16684
|
"x-displayname": "Namespace",
|
|
16157
16685
|
"x-ves-example": "Ns1",
|
|
16158
16686
|
"x-f5xc-example": "ns1",
|
|
16687
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
16159
16688
|
"minLength": 0,
|
|
16160
16689
|
"maxLength": 6,
|
|
16161
16690
|
"x-f5xc-required-for": {
|
|
@@ -16166,7 +16695,7 @@
|
|
|
16166
16695
|
},
|
|
16167
16696
|
"x-original-maxLength": 1024,
|
|
16168
16697
|
"x-reconciled-from-discovery": true,
|
|
16169
|
-
"x-reconciled-at": "2026-01-
|
|
16698
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358784+00:00"
|
|
16170
16699
|
}
|
|
16171
16700
|
},
|
|
16172
16701
|
"x-f5xc-minimum-configuration": {
|
|
@@ -16201,6 +16730,7 @@
|
|
|
16201
16730
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16202
16731
|
},
|
|
16203
16732
|
"x-displayname": "Deleted Referred Objects.",
|
|
16733
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
16204
16734
|
"x-f5xc-required-for": {
|
|
16205
16735
|
"minimum_config": false,
|
|
16206
16736
|
"create": false,
|
|
@@ -16216,6 +16746,7 @@
|
|
|
16216
16746
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16217
16747
|
},
|
|
16218
16748
|
"x-displayname": "Disabled Referred Objects.",
|
|
16749
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
16219
16750
|
"x-f5xc-required-for": {
|
|
16220
16751
|
"minimum_config": false,
|
|
16221
16752
|
"create": false,
|
|
@@ -16234,6 +16765,7 @@
|
|
|
16234
16765
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
16235
16766
|
},
|
|
16236
16767
|
"x-displayname": "Referring Objects.",
|
|
16768
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
16237
16769
|
"x-f5xc-required-for": {
|
|
16238
16770
|
"minimum_config": false,
|
|
16239
16771
|
"create": false,
|
|
@@ -16255,6 +16787,8 @@
|
|
|
16255
16787
|
"$ref": "#/components/schemas/secret_policy_ruleStatusObject"
|
|
16256
16788
|
},
|
|
16257
16789
|
"x-displayname": "Status",
|
|
16790
|
+
"x-f5xc-example": "active",
|
|
16791
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
16258
16792
|
"x-f5xc-required-for": {
|
|
16259
16793
|
"minimum_config": false,
|
|
16260
16794
|
"create": false,
|
|
@@ -16264,7 +16798,7 @@
|
|
|
16264
16798
|
"maxLength": 17,
|
|
16265
16799
|
"minLength": 17,
|
|
16266
16800
|
"x-reconciled-from-discovery": true,
|
|
16267
|
-
"x-reconciled-at": "2026-01-
|
|
16801
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358798+00:00"
|
|
16268
16802
|
},
|
|
16269
16803
|
"system_metadata": {
|
|
16270
16804
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -16304,6 +16838,8 @@
|
|
|
16304
16838
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
16305
16839
|
],
|
|
16306
16840
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
16841
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
16842
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
16307
16843
|
"x-f5xc-minimum-configuration": {
|
|
16308
16844
|
"description": "Minimum configuration for secret_policy_ruleGetResponseFormatCode",
|
|
16309
16845
|
"required_fields": [],
|
|
@@ -16329,6 +16865,7 @@
|
|
|
16329
16865
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
16330
16866
|
},
|
|
16331
16867
|
"x-displayname": "Errors",
|
|
16868
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
16332
16869
|
"x-f5xc-required-for": {
|
|
16333
16870
|
"minimum_config": false,
|
|
16334
16871
|
"create": false,
|
|
@@ -16344,6 +16881,8 @@
|
|
|
16344
16881
|
"$ref": "#/components/schemas/secret_policy_ruleListResponseItem"
|
|
16345
16882
|
},
|
|
16346
16883
|
"x-displayname": "Items",
|
|
16884
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
16885
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
16347
16886
|
"x-f5xc-required-for": {
|
|
16348
16887
|
"minimum_config": false,
|
|
16349
16888
|
"create": false,
|
|
@@ -16377,6 +16916,8 @@
|
|
|
16377
16916
|
"description": "The set of annotations present on this secret_policy_rule.",
|
|
16378
16917
|
"title": "Annotations.",
|
|
16379
16918
|
"x-displayname": "Annotations.",
|
|
16919
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16920
|
+
"x-f5xc-description-short": "The set of annotations present on this secret_policy_rule.",
|
|
16380
16921
|
"x-f5xc-required-for": {
|
|
16381
16922
|
"minimum_config": false,
|
|
16382
16923
|
"create": false,
|
|
@@ -16389,6 +16930,7 @@
|
|
|
16389
16930
|
"description": "The description set for this secret_policy_rule.",
|
|
16390
16931
|
"title": "Description.",
|
|
16391
16932
|
"x-displayname": "Description.",
|
|
16933
|
+
"x-f5xc-description-short": "The description set for this secret_policy_rule.",
|
|
16392
16934
|
"minLength": 0,
|
|
16393
16935
|
"maxLength": 0,
|
|
16394
16936
|
"x-f5xc-required-for": {
|
|
@@ -16399,7 +16941,7 @@
|
|
|
16399
16941
|
},
|
|
16400
16942
|
"x-original-maxLength": 1024,
|
|
16401
16943
|
"x-reconciled-from-discovery": true,
|
|
16402
|
-
"x-reconciled-at": "2026-01-
|
|
16944
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358810+00:00"
|
|
16403
16945
|
},
|
|
16404
16946
|
"disabled": {
|
|
16405
16947
|
"type": "boolean",
|
|
@@ -16407,6 +16949,8 @@
|
|
|
16407
16949
|
"title": "Disabled",
|
|
16408
16950
|
"format": "boolean",
|
|
16409
16951
|
"x-displayname": "Disabled",
|
|
16952
|
+
"x-f5xc-example": "True",
|
|
16953
|
+
"x-f5xc-description-short": "Value of true indicates secret_policy_rule is administratively disabled.",
|
|
16410
16954
|
"x-f5xc-required-for": {
|
|
16411
16955
|
"minimum_config": false,
|
|
16412
16956
|
"create": false,
|
|
@@ -16422,6 +16966,8 @@
|
|
|
16422
16966
|
"description": "The set of labels present on this secret_policy_rule.",
|
|
16423
16967
|
"title": "Labels",
|
|
16424
16968
|
"x-displayname": "Labels",
|
|
16969
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
16970
|
+
"x-f5xc-description-short": "The set of labels present on this secret_policy_rule.",
|
|
16425
16971
|
"x-f5xc-required-for": {
|
|
16426
16972
|
"minimum_config": false,
|
|
16427
16973
|
"create": false,
|
|
@@ -16449,7 +16995,7 @@
|
|
|
16449
16995
|
},
|
|
16450
16996
|
"x-original-maxLength": 1024,
|
|
16451
16997
|
"x-reconciled-from-discovery": true,
|
|
16452
|
-
"x-reconciled-at": "2026-01-
|
|
16998
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358820+00:00"
|
|
16453
16999
|
},
|
|
16454
17000
|
"namespace": {
|
|
16455
17001
|
"type": "string",
|
|
@@ -16468,7 +17014,7 @@
|
|
|
16468
17014
|
},
|
|
16469
17015
|
"x-original-maxLength": 1024,
|
|
16470
17016
|
"x-reconciled-from-discovery": true,
|
|
16471
|
-
"x-reconciled-at": "2026-01-
|
|
17017
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358824+00:00"
|
|
16472
17018
|
},
|
|
16473
17019
|
"owner_view": {
|
|
16474
17020
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -16481,6 +17027,7 @@
|
|
|
16481
17027
|
"$ref": "#/components/schemas/secret_policy_ruleStatusObject"
|
|
16482
17028
|
},
|
|
16483
17029
|
"x-displayname": "Status",
|
|
17030
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
16484
17031
|
"x-f5xc-required-for": {
|
|
16485
17032
|
"minimum_config": false,
|
|
16486
17033
|
"create": false,
|
|
@@ -16509,7 +17056,7 @@
|
|
|
16509
17056
|
"x-field-mutability": "read-only",
|
|
16510
17057
|
"x-original-maxLength": 1024,
|
|
16511
17058
|
"x-reconciled-from-discovery": true,
|
|
16512
|
-
"x-reconciled-at": "2026-01-
|
|
17059
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358831+00:00"
|
|
16513
17060
|
},
|
|
16514
17061
|
"uid": {
|
|
16515
17062
|
"type": "string",
|
|
@@ -16518,6 +17065,7 @@
|
|
|
16518
17065
|
"x-displayname": "UID",
|
|
16519
17066
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
16520
17067
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
17068
|
+
"x-f5xc-description-short": "The unique uid of this secret_policy_rule.",
|
|
16521
17069
|
"minLength": 0,
|
|
16522
17070
|
"maxLength": 36,
|
|
16523
17071
|
"x-f5xc-required-for": {
|
|
@@ -16530,9 +17078,11 @@
|
|
|
16530
17078
|
"x-original-maxLength": 1024,
|
|
16531
17079
|
"format": "uuid",
|
|
16532
17080
|
"x-reconciled-from-discovery": true,
|
|
16533
|
-
"x-reconciled-at": "2026-01-
|
|
17081
|
+
"x-reconciled-at": "2026-01-07T15:53:58.358836+00:00"
|
|
16534
17082
|
}
|
|
16535
17083
|
},
|
|
17084
|
+
"x-f5xc-description-short": "By default a summary of secret_policy_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
17085
|
+
"x-f5xc-description-medium": "By default a summary of secret_policy_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
16536
17086
|
"x-f5xc-minimum-configuration": {
|
|
16537
17087
|
"description": "Minimum configuration for secret_policy_ruleListResponseItem",
|
|
16538
17088
|
"required_fields": [
|
|
@@ -16638,6 +17188,7 @@
|
|
|
16638
17188
|
}
|
|
16639
17189
|
}
|
|
16640
17190
|
},
|
|
17191
|
+
"x-f5xc-description-short": "Most recent observed status of the object.",
|
|
16641
17192
|
"x-f5xc-minimum-configuration": {
|
|
16642
17193
|
"description": "Minimum configuration for secret_policy_ruleStatusObject",
|
|
16643
17194
|
"required_fields": [
|
|
@@ -16669,6 +17220,8 @@
|
|
|
16669
17220
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16670
17221
|
"x-ves-example": "72h",
|
|
16671
17222
|
"x-f5xc-example": "72h",
|
|
17223
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17224
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16672
17225
|
"minLength": 0,
|
|
16673
17226
|
"maxLength": 1024,
|
|
16674
17227
|
"x-f5xc-required-for": {
|
|
@@ -16692,6 +17245,8 @@
|
|
|
16692
17245
|
"x-validation-rules": {
|
|
16693
17246
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16694
17247
|
},
|
|
17248
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17249
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16695
17250
|
"x-f5xc-required-for": {
|
|
16696
17251
|
"minimum_config": false,
|
|
16697
17252
|
"create": false,
|
|
@@ -16700,6 +17255,7 @@
|
|
|
16700
17255
|
}
|
|
16701
17256
|
}
|
|
16702
17257
|
},
|
|
17258
|
+
"x-f5xc-description-short": "Create voltshare_admin_policy creates a new object in the storage backend for metadata.namespace.",
|
|
16703
17259
|
"x-f5xc-minimum-configuration": {
|
|
16704
17260
|
"description": "Minimum configuration for schemavoltshare_admin_policyCreateSpecType",
|
|
16705
17261
|
"required_fields": [
|
|
@@ -16731,6 +17287,8 @@
|
|
|
16731
17287
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16732
17288
|
"x-ves-example": "72h",
|
|
16733
17289
|
"x-f5xc-example": "72h",
|
|
17290
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17291
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16734
17292
|
"minLength": 0,
|
|
16735
17293
|
"maxLength": 1024,
|
|
16736
17294
|
"x-f5xc-required-for": {
|
|
@@ -16754,6 +17312,8 @@
|
|
|
16754
17312
|
"x-validation-rules": {
|
|
16755
17313
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16756
17314
|
},
|
|
17315
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17316
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16757
17317
|
"x-f5xc-required-for": {
|
|
16758
17318
|
"minimum_config": false,
|
|
16759
17319
|
"create": false,
|
|
@@ -16762,6 +17322,7 @@
|
|
|
16762
17322
|
}
|
|
16763
17323
|
}
|
|
16764
17324
|
},
|
|
17325
|
+
"x-f5xc-description-short": "GET voltshare_admin_policy reads a given object from storage backend for metadata.namespace.",
|
|
16765
17326
|
"x-f5xc-minimum-configuration": {
|
|
16766
17327
|
"description": "Minimum configuration for schemavoltshare_admin_policyGetSpecType",
|
|
16767
17328
|
"required_fields": [
|
|
@@ -16802,6 +17363,7 @@
|
|
|
16802
17363
|
"ves.io.schema.rules.string.max_bytes": "256",
|
|
16803
17364
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
16804
17365
|
},
|
|
17366
|
+
"x-f5xc-description-short": "Exclusive with [regex_pattern] exact_match contains user_id to match against.",
|
|
16805
17367
|
"x-f5xc-required-for": {
|
|
16806
17368
|
"minimum_config": false,
|
|
16807
17369
|
"create": false,
|
|
@@ -16826,6 +17388,7 @@
|
|
|
16826
17388
|
"ves.io.schema.rules.string.min_bytes": "1",
|
|
16827
17389
|
"ves.io.schema.rules.string.regex": "true"
|
|
16828
17390
|
},
|
|
17391
|
+
"x-f5xc-description-short": "Exclusive with [exact_value] regex_values contains a regex pattern to match against.",
|
|
16829
17392
|
"x-f5xc-required-for": {
|
|
16830
17393
|
"minimum_config": false,
|
|
16831
17394
|
"create": false,
|
|
@@ -16834,6 +17397,8 @@
|
|
|
16834
17397
|
}
|
|
16835
17398
|
}
|
|
16836
17399
|
},
|
|
17400
|
+
"x-f5xc-description-short": "MatcherType contains the choice of value to be compared against the input userid.",
|
|
17401
|
+
"x-f5xc-description-medium": "MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.",
|
|
16837
17402
|
"x-f5xc-minimum-configuration": {
|
|
16838
17403
|
"description": "Minimum configuration for schemavoltshare_admin_policyMatcherType",
|
|
16839
17404
|
"required_fields": [
|
|
@@ -16864,6 +17429,8 @@
|
|
|
16864
17429
|
"x-displayname": "Maximum Duration for Validity.",
|
|
16865
17430
|
"x-ves-example": "72h",
|
|
16866
17431
|
"x-f5xc-example": "72h",
|
|
17432
|
+
"x-f5xc-description-short": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid.",
|
|
17433
|
+
"x-f5xc-description-medium": "Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix \"s\" (indicating seconds), suffix \"m\" (indicating minutes) or suffix \"h\" (indicating hours).",
|
|
16867
17434
|
"minLength": 0,
|
|
16868
17435
|
"maxLength": 1024,
|
|
16869
17436
|
"x-f5xc-required-for": {
|
|
@@ -16887,6 +17454,8 @@
|
|
|
16887
17454
|
"x-validation-rules": {
|
|
16888
17455
|
"ves.io.schema.rules.repeated.max_items": "16"
|
|
16889
17456
|
},
|
|
17457
|
+
"x-f5xc-description-short": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
17458
|
+
"x-f5xc-description-medium": "User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.",
|
|
16890
17459
|
"x-f5xc-required-for": {
|
|
16891
17460
|
"minimum_config": false,
|
|
16892
17461
|
"create": false,
|
|
@@ -16895,6 +17464,8 @@
|
|
|
16895
17464
|
}
|
|
16896
17465
|
}
|
|
16897
17466
|
},
|
|
17467
|
+
"x-f5xc-description-short": "Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
17468
|
+
"x-f5xc-description-medium": "Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
16898
17469
|
"x-f5xc-minimum-configuration": {
|
|
16899
17470
|
"description": "Minimum configuration for schemavoltshare_admin_policyReplaceSpecType",
|
|
16900
17471
|
"required_fields": [
|
|
@@ -16998,6 +17569,7 @@
|
|
|
16998
17569
|
}
|
|
16999
17570
|
}
|
|
17000
17571
|
},
|
|
17572
|
+
"x-f5xc-description-short": "Custom List contains user customized list of matcher values.",
|
|
17001
17573
|
"x-f5xc-minimum-configuration": {
|
|
17002
17574
|
"description": "Minimum configuration for voltshare_admin_policyCustomListType",
|
|
17003
17575
|
"required_fields": [
|
|
@@ -17023,6 +17595,7 @@
|
|
|
17023
17595
|
"title": "Fail_if_referred.",
|
|
17024
17596
|
"format": "boolean",
|
|
17025
17597
|
"x-displayname": "Fail-If-Referred.",
|
|
17598
|
+
"x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.",
|
|
17026
17599
|
"x-f5xc-required-for": {
|
|
17027
17600
|
"minimum_config": false,
|
|
17028
17601
|
"create": false,
|
|
@@ -17047,7 +17620,7 @@
|
|
|
17047
17620
|
},
|
|
17048
17621
|
"x-original-maxLength": 1024,
|
|
17049
17622
|
"x-reconciled-from-discovery": true,
|
|
17050
|
-
"x-reconciled-at": "2026-01-
|
|
17623
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035658+00:00"
|
|
17051
17624
|
},
|
|
17052
17625
|
"namespace": {
|
|
17053
17626
|
"type": "string",
|
|
@@ -17056,6 +17629,7 @@
|
|
|
17056
17629
|
"x-displayname": "Namespace",
|
|
17057
17630
|
"x-ves-example": "Ns1",
|
|
17058
17631
|
"x-f5xc-example": "ns1",
|
|
17632
|
+
"x-f5xc-description-short": "Namespace in which the configuration object is present.",
|
|
17059
17633
|
"minLength": 0,
|
|
17060
17634
|
"maxLength": 6,
|
|
17061
17635
|
"x-f5xc-required-for": {
|
|
@@ -17066,7 +17640,7 @@
|
|
|
17066
17640
|
},
|
|
17067
17641
|
"x-original-maxLength": 1024,
|
|
17068
17642
|
"x-reconciled-from-discovery": true,
|
|
17069
|
-
"x-reconciled-at": "2026-01-
|
|
17643
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035663+00:00"
|
|
17070
17644
|
}
|
|
17071
17645
|
},
|
|
17072
17646
|
"x-f5xc-minimum-configuration": {
|
|
@@ -17101,6 +17675,7 @@
|
|
|
17101
17675
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
17102
17676
|
},
|
|
17103
17677
|
"x-displayname": "Deleted Referred Objects.",
|
|
17678
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
17104
17679
|
"x-f5xc-required-for": {
|
|
17105
17680
|
"minimum_config": false,
|
|
17106
17681
|
"create": false,
|
|
@@ -17116,6 +17691,7 @@
|
|
|
17116
17691
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
17117
17692
|
},
|
|
17118
17693
|
"x-displayname": "Disabled Referred Objects.",
|
|
17694
|
+
"x-f5xc-description-short": "The set of deleted objects that are referred by this object.",
|
|
17119
17695
|
"x-f5xc-required-for": {
|
|
17120
17696
|
"minimum_config": false,
|
|
17121
17697
|
"create": false,
|
|
@@ -17134,6 +17710,7 @@
|
|
|
17134
17710
|
"$ref": "#/components/schemas/ioschemaObjectRefType"
|
|
17135
17711
|
},
|
|
17136
17712
|
"x-displayname": "Referring Objects.",
|
|
17713
|
+
"x-f5xc-description-short": "The set of objects that are referring to this object in their spec.",
|
|
17137
17714
|
"x-f5xc-required-for": {
|
|
17138
17715
|
"minimum_config": false,
|
|
17139
17716
|
"create": false,
|
|
@@ -17155,6 +17732,8 @@
|
|
|
17155
17732
|
"$ref": "#/components/schemas/voltshare_admin_policyStatusObject"
|
|
17156
17733
|
},
|
|
17157
17734
|
"x-displayname": "Status",
|
|
17735
|
+
"x-f5xc-example": "active",
|
|
17736
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
17158
17737
|
"x-f5xc-required-for": {
|
|
17159
17738
|
"minimum_config": false,
|
|
17160
17739
|
"create": false,
|
|
@@ -17164,7 +17743,7 @@
|
|
|
17164
17743
|
"maxLength": 17,
|
|
17165
17744
|
"minLength": 17,
|
|
17166
17745
|
"x-reconciled-from-discovery": true,
|
|
17167
|
-
"x-reconciled-at": "2026-01-
|
|
17746
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035677+00:00"
|
|
17168
17747
|
},
|
|
17169
17748
|
"system_metadata": {
|
|
17170
17749
|
"$ref": "#/components/schemas/schemaSystemObjectGetMetaType"
|
|
@@ -17204,6 +17783,8 @@
|
|
|
17204
17783
|
"GET_RSP_FORMAT_BROKEN_REFERENCES"
|
|
17205
17784
|
],
|
|
17206
17785
|
"default": "GET_RSP_FORMAT_DEFAULT",
|
|
17786
|
+
"x-f5xc-description-short": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT...",
|
|
17787
|
+
"x-f5xc-description-medium": "X-displayName: \"GET Response Format\" This is the various forms that can be requested to be sent in the GetResponse - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\" Default format of returned resource - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\" Response should be...",
|
|
17207
17788
|
"x-f5xc-minimum-configuration": {
|
|
17208
17789
|
"description": "Minimum configuration for voltshare_admin_policyGetResponseFormatCode",
|
|
17209
17790
|
"required_fields": [],
|
|
@@ -17229,6 +17810,7 @@
|
|
|
17229
17810
|
"$ref": "#/components/schemas/schemaErrorType"
|
|
17230
17811
|
},
|
|
17231
17812
|
"x-displayname": "Errors",
|
|
17813
|
+
"x-f5xc-description-short": "Errors(if any) while listing items from collection.",
|
|
17232
17814
|
"x-f5xc-required-for": {
|
|
17233
17815
|
"minimum_config": false,
|
|
17234
17816
|
"create": false,
|
|
@@ -17244,6 +17826,8 @@
|
|
|
17244
17826
|
"$ref": "#/components/schemas/voltshare_admin_policyListResponseItem"
|
|
17245
17827
|
},
|
|
17246
17828
|
"x-displayname": "Items",
|
|
17829
|
+
"x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]",
|
|
17830
|
+
"x-f5xc-description-short": "Items represents the collection in response.",
|
|
17247
17831
|
"x-f5xc-required-for": {
|
|
17248
17832
|
"minimum_config": false,
|
|
17249
17833
|
"create": false,
|
|
@@ -17277,6 +17861,8 @@
|
|
|
17277
17861
|
"description": "The set of annotations present on this voltshare_admin_policy.",
|
|
17278
17862
|
"title": "Annotations.",
|
|
17279
17863
|
"x-displayname": "Annotations.",
|
|
17864
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
17865
|
+
"x-f5xc-description-short": "The set of annotations present on this voltshare_admin_policy.",
|
|
17280
17866
|
"x-f5xc-required-for": {
|
|
17281
17867
|
"minimum_config": false,
|
|
17282
17868
|
"create": false,
|
|
@@ -17289,6 +17875,7 @@
|
|
|
17289
17875
|
"description": "The description set for this voltshare_admin_policy.",
|
|
17290
17876
|
"title": "Description.",
|
|
17291
17877
|
"x-displayname": "Description.",
|
|
17878
|
+
"x-f5xc-description-short": "The description set for this voltshare_admin_policy.",
|
|
17292
17879
|
"minLength": 0,
|
|
17293
17880
|
"maxLength": 0,
|
|
17294
17881
|
"x-f5xc-required-for": {
|
|
@@ -17299,7 +17886,7 @@
|
|
|
17299
17886
|
},
|
|
17300
17887
|
"x-original-maxLength": 1024,
|
|
17301
17888
|
"x-reconciled-from-discovery": true,
|
|
17302
|
-
"x-reconciled-at": "2026-01-
|
|
17889
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035688+00:00"
|
|
17303
17890
|
},
|
|
17304
17891
|
"disabled": {
|
|
17305
17892
|
"type": "boolean",
|
|
@@ -17307,6 +17894,8 @@
|
|
|
17307
17894
|
"title": "Disabled",
|
|
17308
17895
|
"format": "boolean",
|
|
17309
17896
|
"x-displayname": "Disabled",
|
|
17897
|
+
"x-f5xc-example": "True",
|
|
17898
|
+
"x-f5xc-description-short": "Value of true indicates voltshare_admin_policy is administratively disabled.",
|
|
17310
17899
|
"x-f5xc-required-for": {
|
|
17311
17900
|
"minimum_config": false,
|
|
17312
17901
|
"create": false,
|
|
@@ -17322,6 +17911,8 @@
|
|
|
17322
17911
|
"description": "The set of labels present on this voltshare_admin_policy.",
|
|
17323
17912
|
"title": "Labels",
|
|
17324
17913
|
"x-displayname": "Labels",
|
|
17914
|
+
"x-f5xc-example": "{\"key\": \"value\"}",
|
|
17915
|
+
"x-f5xc-description-short": "The set of labels present on this voltshare_admin_policy.",
|
|
17325
17916
|
"x-f5xc-required-for": {
|
|
17326
17917
|
"minimum_config": false,
|
|
17327
17918
|
"create": false,
|
|
@@ -17339,6 +17930,7 @@
|
|
|
17339
17930
|
"x-displayname": "Name",
|
|
17340
17931
|
"x-ves-example": "Name",
|
|
17341
17932
|
"x-f5xc-example": "name",
|
|
17933
|
+
"x-f5xc-description-short": "The name of this voltshare_admin_policy.",
|
|
17342
17934
|
"minLength": 0,
|
|
17343
17935
|
"maxLength": 16,
|
|
17344
17936
|
"x-f5xc-required-for": {
|
|
@@ -17349,7 +17941,7 @@
|
|
|
17349
17941
|
},
|
|
17350
17942
|
"x-original-maxLength": 1024,
|
|
17351
17943
|
"x-reconciled-from-discovery": true,
|
|
17352
|
-
"x-reconciled-at": "2026-01-
|
|
17944
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035698+00:00"
|
|
17353
17945
|
},
|
|
17354
17946
|
"namespace": {
|
|
17355
17947
|
"type": "string",
|
|
@@ -17368,7 +17960,7 @@
|
|
|
17368
17960
|
},
|
|
17369
17961
|
"x-original-maxLength": 1024,
|
|
17370
17962
|
"x-reconciled-from-discovery": true,
|
|
17371
|
-
"x-reconciled-at": "2026-01-
|
|
17963
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035702+00:00"
|
|
17372
17964
|
},
|
|
17373
17965
|
"owner_view": {
|
|
17374
17966
|
"$ref": "#/components/schemas/schemaViewRefType"
|
|
@@ -17381,6 +17973,7 @@
|
|
|
17381
17973
|
"$ref": "#/components/schemas/voltshare_admin_policyStatusObject"
|
|
17382
17974
|
},
|
|
17383
17975
|
"x-displayname": "Status",
|
|
17976
|
+
"x-f5xc-description-short": "The status reported by different services for this configuration object.",
|
|
17384
17977
|
"x-f5xc-required-for": {
|
|
17385
17978
|
"minimum_config": false,
|
|
17386
17979
|
"create": false,
|
|
@@ -17409,7 +18002,7 @@
|
|
|
17409
18002
|
"x-field-mutability": "read-only",
|
|
17410
18003
|
"x-original-maxLength": 1024,
|
|
17411
18004
|
"x-reconciled-from-discovery": true,
|
|
17412
|
-
"x-reconciled-at": "2026-01-
|
|
18005
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035709+00:00"
|
|
17413
18006
|
},
|
|
17414
18007
|
"uid": {
|
|
17415
18008
|
"type": "string",
|
|
@@ -17418,6 +18011,7 @@
|
|
|
17418
18011
|
"x-displayname": "UID",
|
|
17419
18012
|
"x-ves-example": "D27938ba-967e-40a7-9709-57b8627f9f75.",
|
|
17420
18013
|
"x-f5xc-example": "d27938ba-967e-40a7-9709-57b8627f9f75",
|
|
18014
|
+
"x-f5xc-description-short": "The unique uid of this voltshare_admin_policy.",
|
|
17421
18015
|
"minLength": 0,
|
|
17422
18016
|
"maxLength": 36,
|
|
17423
18017
|
"x-f5xc-required-for": {
|
|
@@ -17430,9 +18024,11 @@
|
|
|
17430
18024
|
"x-original-maxLength": 1024,
|
|
17431
18025
|
"format": "uuid",
|
|
17432
18026
|
"x-reconciled-from-discovery": true,
|
|
17433
|
-
"x-reconciled-at": "2026-01-
|
|
18027
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035714+00:00"
|
|
17434
18028
|
}
|
|
17435
18029
|
},
|
|
18030
|
+
"x-f5xc-description-short": "By default a summary of voltshare_admin_policy is returned in 'List'.",
|
|
18031
|
+
"x-f5xc-description-medium": "By default a summary of voltshare_admin_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.",
|
|
17436
18032
|
"x-f5xc-minimum-configuration": {
|
|
17437
18033
|
"description": "Minimum configuration for voltshare_admin_policyListResponseItem",
|
|
17438
18034
|
"required_fields": [
|
|
@@ -17512,6 +18108,7 @@
|
|
|
17512
18108
|
"$ref": "#/components/schemas/schemaConditionType"
|
|
17513
18109
|
},
|
|
17514
18110
|
"x-displayname": "Conditions.",
|
|
18111
|
+
"x-f5xc-description-short": "Conditions reported by various component of the system.",
|
|
17515
18112
|
"x-f5xc-required-for": {
|
|
17516
18113
|
"minimum_config": false,
|
|
17517
18114
|
"create": false,
|
|
@@ -17538,6 +18135,7 @@
|
|
|
17538
18135
|
}
|
|
17539
18136
|
}
|
|
17540
18137
|
},
|
|
18138
|
+
"x-f5xc-description-short": "Most recently observed status of object.",
|
|
17541
18139
|
"x-f5xc-minimum-configuration": {
|
|
17542
18140
|
"description": "Minimum configuration for voltshare_admin_policyStatusObject",
|
|
17543
18141
|
"required_fields": [
|
|
@@ -17574,6 +18172,7 @@
|
|
|
17574
18172
|
"$ref": "#/components/schemas/voltshare_admin_policyCustomListType"
|
|
17575
18173
|
}
|
|
17576
18174
|
},
|
|
18175
|
+
"x-f5xc-description-short": "User_matcher contains contains the allow/deny list of users/authors.",
|
|
17577
18176
|
"x-f5xc-minimum-configuration": {
|
|
17578
18177
|
"description": "Minimum configuration for voltshare_admin_policyUserMatcherType",
|
|
17579
18178
|
"required_fields": [
|
|
@@ -17619,6 +18218,8 @@
|
|
|
17619
18218
|
"ves.io.schema.rules.string.max_bytes": "256",
|
|
17620
18219
|
"ves.io.schema.rules.string.min_bytes": "1"
|
|
17621
18220
|
},
|
|
18221
|
+
"x-f5xc-example": "customer-123",
|
|
18222
|
+
"x-f5xc-description-short": "Exclusive with [all_tenants individual_users] Team/Tenant for which this rule is valid.",
|
|
17622
18223
|
"x-f5xc-required-for": {
|
|
17623
18224
|
"minimum_config": false,
|
|
17624
18225
|
"create": false,
|
|
@@ -17628,12 +18229,14 @@
|
|
|
17628
18229
|
"x-field-mutability": "read-only",
|
|
17629
18230
|
"x-original-maxLength": 256,
|
|
17630
18231
|
"x-reconciled-from-discovery": true,
|
|
17631
|
-
"x-reconciled-at": "2026-01-
|
|
18232
|
+
"x-reconciled-at": "2026-01-07T15:54:26.035733+00:00"
|
|
17632
18233
|
},
|
|
17633
18234
|
"user_restrictions": {
|
|
17634
18235
|
"$ref": "#/components/schemas/voltshare_admin_policyUserMatcherType"
|
|
17635
18236
|
}
|
|
17636
18237
|
},
|
|
18238
|
+
"x-f5xc-description-short": "User_restrictions contains list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare for any given team/tenant.",
|
|
18239
|
+
"x-f5xc-description-medium": "User_restrictions contains list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare for any given team/tenant.",
|
|
17637
18240
|
"x-f5xc-minimum-configuration": {
|
|
17638
18241
|
"description": "Minimum configuration for voltshare_admin_policyUserRestrictionType",
|
|
17639
18242
|
"required_fields": [
|