@robinmordasiewicz/f5xc-api-mcp 3.3.0 → 3.4.0
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/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +6668 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +1005 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +2045 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2702 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3998 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1904 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3963 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2579 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +2054 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1770 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +8511 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +6460 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +1215 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4580 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +12616 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +8884 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1820 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +1055 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +4243 -4618
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1937 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +4532 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +21784 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +13252 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +8837 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +6215 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +112 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1572 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +11540 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +4440 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -0,0 +1,3998 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for blindfold domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const blindfoldTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-blindfold-access-count-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare/access_count",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "blindfold",
|
|
12
|
+
resource: "access-count",
|
|
13
|
+
summary: "VoltShare Access Count Query.",
|
|
14
|
+
description: "Request to GET number of VoltShare API calls aggregated across multiple dimensions like OPERATION, COUNTRY, RESULT, USER_TENANT.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: "Namespace\nnamespace is used to scope the security events for the given namespace.",
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "namespace",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Blogging-app-namespace-1.",
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
queryParameters: [],
|
|
29
|
+
requestBodySchema: {
|
|
30
|
+
$ref: "#/components/schemas/voltshareVoltShareAccessCountRequest",
|
|
31
|
+
},
|
|
32
|
+
responseSchema: {
|
|
33
|
+
$ref: "#/components/schemas/voltshareVoltShareAccessCountResponse",
|
|
34
|
+
},
|
|
35
|
+
requiredParams: ["body", "namespace"],
|
|
36
|
+
operationId: "ves.io.schema.voltshare.MonitoringAPI.VoltShareAccessCountQuery",
|
|
37
|
+
tags: ["Security"],
|
|
38
|
+
sourceFile: "domains/blindfold.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["access-count"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
45
|
+
cliExamples: [
|
|
46
|
+
{
|
|
47
|
+
command: "f5xcctl secret_management access-count create {name} --namespace {namespace}",
|
|
48
|
+
description: "Create access-count",
|
|
49
|
+
use_case: "basic_create",
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
command: "f5xcctl secret_management access-count create -f {file}.yaml",
|
|
53
|
+
description: "Create from YAML file",
|
|
54
|
+
use_case: "file_based",
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
confirmationRequired: false,
|
|
58
|
+
parameterExamples: {
|
|
59
|
+
namespace: "Blogging-app-namespace-1.",
|
|
60
|
+
},
|
|
61
|
+
validationRules: {},
|
|
62
|
+
operationMetadata: {
|
|
63
|
+
common_errors: [
|
|
64
|
+
{
|
|
65
|
+
code: 401,
|
|
66
|
+
message: "Authentication required",
|
|
67
|
+
solution: "Provide valid API credentials",
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
code: 403,
|
|
71
|
+
message: "Permission denied",
|
|
72
|
+
solution: "Check access permissions for this operation",
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
code: 404,
|
|
76
|
+
message: "Resource not found",
|
|
77
|
+
solution: "Verify resource name, namespace, and path",
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
code: 409,
|
|
81
|
+
message: "Resource already exists",
|
|
82
|
+
solution: "Use different name or update existing resource",
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
code: 429,
|
|
86
|
+
message: "Rate limit exceeded",
|
|
87
|
+
solution: "Wait before retrying the operation",
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
code: 500,
|
|
91
|
+
message: "Server error",
|
|
92
|
+
solution: "Retry operation or contact support",
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
conditions: {
|
|
96
|
+
postconditions: ["Access-count resource created", "Resource assigned unique identifier"],
|
|
97
|
+
prerequisites: ["Active namespace"],
|
|
98
|
+
},
|
|
99
|
+
confirmation_required: false,
|
|
100
|
+
danger_level: "medium",
|
|
101
|
+
examples: [
|
|
102
|
+
{
|
|
103
|
+
command: "f5xcctl secret_management access-count create {name} --namespace {namespace}",
|
|
104
|
+
description: "Create access-count",
|
|
105
|
+
use_case: "basic_create",
|
|
106
|
+
},
|
|
107
|
+
{
|
|
108
|
+
command: "f5xcctl secret_management access-count create -f {file}.yaml",
|
|
109
|
+
description: "Create from YAML file",
|
|
110
|
+
use_case: "file_based",
|
|
111
|
+
},
|
|
112
|
+
],
|
|
113
|
+
field_docs: {},
|
|
114
|
+
optional_fields: [],
|
|
115
|
+
performance_impact: {
|
|
116
|
+
latency: "low",
|
|
117
|
+
resource_usage: "low",
|
|
118
|
+
},
|
|
119
|
+
purpose: "Create new access-count",
|
|
120
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
121
|
+
side_effects: {
|
|
122
|
+
creates: ["access-count"],
|
|
123
|
+
},
|
|
124
|
+
},
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
toolName: "f5xc-api-blindfold-aggregation-create",
|
|
128
|
+
method: "POST",
|
|
129
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/aggregation",
|
|
130
|
+
operation: "create",
|
|
131
|
+
domain: "blindfold",
|
|
132
|
+
resource: "aggregation",
|
|
133
|
+
summary: "Audit Log Aggregation Query.",
|
|
134
|
+
description: "Request to GET summary/analytics data for the audit logs that matches the criteria in request.",
|
|
135
|
+
pathParameters: [
|
|
136
|
+
{
|
|
137
|
+
description: "Namespace\nfetch aggregation data scoped by namespace.",
|
|
138
|
+
in: "path",
|
|
139
|
+
name: "namespace",
|
|
140
|
+
required: true,
|
|
141
|
+
schema: {
|
|
142
|
+
type: "string",
|
|
143
|
+
},
|
|
144
|
+
"x-displayname": "Namespace",
|
|
145
|
+
"x-ves-example": "Value",
|
|
146
|
+
},
|
|
147
|
+
],
|
|
148
|
+
queryParameters: [],
|
|
149
|
+
requestBodySchema: {
|
|
150
|
+
$ref: "#/components/schemas/voltshareAuditLogAggregationRequest",
|
|
151
|
+
},
|
|
152
|
+
responseSchema: {
|
|
153
|
+
$ref: "#/components/schemas/voltshareAuditLogAggregationResponse",
|
|
154
|
+
},
|
|
155
|
+
requiredParams: ["body", "namespace"],
|
|
156
|
+
operationId: "ves.io.schema.voltshare.MonitoringAPI.AuditLogAggregationQuery",
|
|
157
|
+
tags: ["Security"],
|
|
158
|
+
sourceFile: "domains/blindfold.json",
|
|
159
|
+
displayName: null,
|
|
160
|
+
dangerLevel: "medium",
|
|
161
|
+
sideEffects: {
|
|
162
|
+
creates: ["aggregation"],
|
|
163
|
+
},
|
|
164
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
165
|
+
cliExamples: [
|
|
166
|
+
{
|
|
167
|
+
command: "f5xcctl secret_management aggregation create {name} --namespace {namespace}",
|
|
168
|
+
description: "Create aggregation",
|
|
169
|
+
use_case: "basic_create",
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
command: "f5xcctl secret_management aggregation create -f {file}.yaml",
|
|
173
|
+
description: "Create from YAML file",
|
|
174
|
+
use_case: "file_based",
|
|
175
|
+
},
|
|
176
|
+
],
|
|
177
|
+
confirmationRequired: false,
|
|
178
|
+
parameterExamples: {
|
|
179
|
+
namespace: "Value",
|
|
180
|
+
},
|
|
181
|
+
validationRules: {},
|
|
182
|
+
operationMetadata: {
|
|
183
|
+
common_errors: [
|
|
184
|
+
{
|
|
185
|
+
code: 401,
|
|
186
|
+
message: "Authentication required",
|
|
187
|
+
solution: "Provide valid API credentials",
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
code: 403,
|
|
191
|
+
message: "Permission denied",
|
|
192
|
+
solution: "Check access permissions for this operation",
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
code: 404,
|
|
196
|
+
message: "Resource not found",
|
|
197
|
+
solution: "Verify resource name, namespace, and path",
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
code: 409,
|
|
201
|
+
message: "Resource already exists",
|
|
202
|
+
solution: "Use different name or update existing resource",
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
code: 429,
|
|
206
|
+
message: "Rate limit exceeded",
|
|
207
|
+
solution: "Wait before retrying the operation",
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
code: 500,
|
|
211
|
+
message: "Server error",
|
|
212
|
+
solution: "Retry operation or contact support",
|
|
213
|
+
},
|
|
214
|
+
],
|
|
215
|
+
conditions: {
|
|
216
|
+
postconditions: ["Aggregation resource created", "Resource assigned unique identifier"],
|
|
217
|
+
prerequisites: ["Active namespace"],
|
|
218
|
+
},
|
|
219
|
+
confirmation_required: false,
|
|
220
|
+
danger_level: "medium",
|
|
221
|
+
examples: [
|
|
222
|
+
{
|
|
223
|
+
command: "f5xcctl secret_management aggregation create {name} --namespace {namespace}",
|
|
224
|
+
description: "Create aggregation",
|
|
225
|
+
use_case: "basic_create",
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
command: "f5xcctl secret_management aggregation create -f {file}.yaml",
|
|
229
|
+
description: "Create from YAML file",
|
|
230
|
+
use_case: "file_based",
|
|
231
|
+
},
|
|
232
|
+
],
|
|
233
|
+
field_docs: {},
|
|
234
|
+
optional_fields: [],
|
|
235
|
+
performance_impact: {
|
|
236
|
+
latency: "low",
|
|
237
|
+
resource_usage: "low",
|
|
238
|
+
},
|
|
239
|
+
purpose: "Create new aggregation",
|
|
240
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
241
|
+
side_effects: {
|
|
242
|
+
creates: ["aggregation"],
|
|
243
|
+
},
|
|
244
|
+
},
|
|
245
|
+
},
|
|
246
|
+
{
|
|
247
|
+
toolName: "f5xc-api-blindfold-audit-log-create",
|
|
248
|
+
method: "POST",
|
|
249
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs",
|
|
250
|
+
operation: "create",
|
|
251
|
+
domain: "blindfold",
|
|
252
|
+
resource: "audit-log",
|
|
253
|
+
summary: "Audit Log Query.",
|
|
254
|
+
description: "Request to GET voltshare audit logs that matches the criteria in request.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed.",
|
|
255
|
+
pathParameters: [
|
|
256
|
+
{
|
|
257
|
+
description: "Namespace\nfetch the log messages scoped by namespace.",
|
|
258
|
+
in: "path",
|
|
259
|
+
name: "namespace",
|
|
260
|
+
required: true,
|
|
261
|
+
schema: {
|
|
262
|
+
type: "string",
|
|
263
|
+
},
|
|
264
|
+
"x-displayname": "Namespace",
|
|
265
|
+
"x-ves-example": "Value",
|
|
266
|
+
},
|
|
267
|
+
],
|
|
268
|
+
queryParameters: [],
|
|
269
|
+
requestBodySchema: {
|
|
270
|
+
$ref: "#/components/schemas/voltshareAuditLogRequest",
|
|
271
|
+
},
|
|
272
|
+
responseSchema: {
|
|
273
|
+
$ref: "#/components/schemas/voltshareAuditLogResponse",
|
|
274
|
+
},
|
|
275
|
+
requiredParams: ["body", "namespace"],
|
|
276
|
+
operationId: "ves.io.schema.voltshare.MonitoringAPI.AuditLogQuery",
|
|
277
|
+
tags: ["Security"],
|
|
278
|
+
sourceFile: "domains/blindfold.json",
|
|
279
|
+
displayName: null,
|
|
280
|
+
dangerLevel: "medium",
|
|
281
|
+
sideEffects: {
|
|
282
|
+
creates: ["audit-log"],
|
|
283
|
+
},
|
|
284
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
285
|
+
cliExamples: [
|
|
286
|
+
{
|
|
287
|
+
command: "f5xcctl secret_management audit-log create {name} --namespace {namespace}",
|
|
288
|
+
description: "Create audit-log",
|
|
289
|
+
use_case: "basic_create",
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
command: "f5xcctl secret_management audit-log create -f {file}.yaml",
|
|
293
|
+
description: "Create from YAML file",
|
|
294
|
+
use_case: "file_based",
|
|
295
|
+
},
|
|
296
|
+
],
|
|
297
|
+
confirmationRequired: false,
|
|
298
|
+
parameterExamples: {
|
|
299
|
+
namespace: "Value",
|
|
300
|
+
},
|
|
301
|
+
validationRules: {},
|
|
302
|
+
operationMetadata: {
|
|
303
|
+
common_errors: [
|
|
304
|
+
{
|
|
305
|
+
code: 401,
|
|
306
|
+
message: "Authentication required",
|
|
307
|
+
solution: "Provide valid API credentials",
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
code: 403,
|
|
311
|
+
message: "Permission denied",
|
|
312
|
+
solution: "Check access permissions for this operation",
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
code: 404,
|
|
316
|
+
message: "Resource not found",
|
|
317
|
+
solution: "Verify resource name, namespace, and path",
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
code: 409,
|
|
321
|
+
message: "Resource already exists",
|
|
322
|
+
solution: "Use different name or update existing resource",
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
code: 429,
|
|
326
|
+
message: "Rate limit exceeded",
|
|
327
|
+
solution: "Wait before retrying the operation",
|
|
328
|
+
},
|
|
329
|
+
{
|
|
330
|
+
code: 500,
|
|
331
|
+
message: "Server error",
|
|
332
|
+
solution: "Retry operation or contact support",
|
|
333
|
+
},
|
|
334
|
+
],
|
|
335
|
+
conditions: {
|
|
336
|
+
postconditions: ["Audit-log resource created", "Resource assigned unique identifier"],
|
|
337
|
+
prerequisites: ["Active namespace"],
|
|
338
|
+
},
|
|
339
|
+
confirmation_required: false,
|
|
340
|
+
danger_level: "medium",
|
|
341
|
+
examples: [
|
|
342
|
+
{
|
|
343
|
+
command: "f5xcctl secret_management audit-log create {name} --namespace {namespace}",
|
|
344
|
+
description: "Create audit-log",
|
|
345
|
+
use_case: "basic_create",
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
command: "f5xcctl secret_management audit-log create -f {file}.yaml",
|
|
349
|
+
description: "Create from YAML file",
|
|
350
|
+
use_case: "file_based",
|
|
351
|
+
},
|
|
352
|
+
],
|
|
353
|
+
field_docs: {},
|
|
354
|
+
optional_fields: [],
|
|
355
|
+
performance_impact: {
|
|
356
|
+
latency: "low",
|
|
357
|
+
resource_usage: "low",
|
|
358
|
+
},
|
|
359
|
+
purpose: "Create new audit-log",
|
|
360
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
361
|
+
side_effects: {
|
|
362
|
+
creates: ["audit-log"],
|
|
363
|
+
},
|
|
364
|
+
},
|
|
365
|
+
},
|
|
366
|
+
{
|
|
367
|
+
toolName: "f5xc-api-blindfold-decrypt-secret-create",
|
|
368
|
+
method: "POST",
|
|
369
|
+
path: "/api/secret_management/namespaces/system/voltshare/decrypt_secret",
|
|
370
|
+
operation: "create",
|
|
371
|
+
domain: "blindfold",
|
|
372
|
+
resource: "decrypt-secret",
|
|
373
|
+
summary: "DecryptSecret.",
|
|
374
|
+
description: "DecryptSecret API takes blinded encrypted secret and policy and responds with blinded decrypted secret if user is allowed by the policy.",
|
|
375
|
+
pathParameters: [],
|
|
376
|
+
queryParameters: [],
|
|
377
|
+
requestBodySchema: {
|
|
378
|
+
$ref: "#/components/schemas/voltshareDecryptSecretRequest",
|
|
379
|
+
},
|
|
380
|
+
responseSchema: {
|
|
381
|
+
$ref: "#/components/schemas/voltshareDecryptSecretResponse",
|
|
382
|
+
},
|
|
383
|
+
requiredParams: ["body"],
|
|
384
|
+
operationId: "ves.io.schema.voltshare.CustomAPI.DecryptSecret",
|
|
385
|
+
tags: ["Security"],
|
|
386
|
+
sourceFile: "domains/blindfold.json",
|
|
387
|
+
displayName: null,
|
|
388
|
+
dangerLevel: "medium",
|
|
389
|
+
sideEffects: {
|
|
390
|
+
creates: ["decrypt-secret"],
|
|
391
|
+
},
|
|
392
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
393
|
+
cliExamples: [
|
|
394
|
+
{
|
|
395
|
+
command: "f5xcctl secret_management decrypt-secret create {name} --namespace {namespace}",
|
|
396
|
+
description: "Create decrypt-secret",
|
|
397
|
+
use_case: "basic_create",
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
command: "f5xcctl secret_management decrypt-secret create -f {file}.yaml",
|
|
401
|
+
description: "Create from YAML file",
|
|
402
|
+
use_case: "file_based",
|
|
403
|
+
},
|
|
404
|
+
],
|
|
405
|
+
confirmationRequired: false,
|
|
406
|
+
parameterExamples: {},
|
|
407
|
+
validationRules: {},
|
|
408
|
+
operationMetadata: {
|
|
409
|
+
common_errors: [
|
|
410
|
+
{
|
|
411
|
+
code: 401,
|
|
412
|
+
message: "Authentication required",
|
|
413
|
+
solution: "Provide valid API credentials",
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
code: 403,
|
|
417
|
+
message: "Permission denied",
|
|
418
|
+
solution: "Check access permissions for this operation",
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
code: 404,
|
|
422
|
+
message: "Resource not found",
|
|
423
|
+
solution: "Verify resource name, namespace, and path",
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
code: 409,
|
|
427
|
+
message: "Resource already exists",
|
|
428
|
+
solution: "Use different name or update existing resource",
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
code: 429,
|
|
432
|
+
message: "Rate limit exceeded",
|
|
433
|
+
solution: "Wait before retrying the operation",
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
code: 500,
|
|
437
|
+
message: "Server error",
|
|
438
|
+
solution: "Retry operation or contact support",
|
|
439
|
+
},
|
|
440
|
+
],
|
|
441
|
+
conditions: {
|
|
442
|
+
postconditions: ["Decrypt-secret resource created", "Resource assigned unique identifier"],
|
|
443
|
+
prerequisites: ["Active namespace"],
|
|
444
|
+
},
|
|
445
|
+
confirmation_required: false,
|
|
446
|
+
danger_level: "medium",
|
|
447
|
+
examples: [
|
|
448
|
+
{
|
|
449
|
+
command: "f5xcctl secret_management decrypt-secret create {name} --namespace {namespace}",
|
|
450
|
+
description: "Create decrypt-secret",
|
|
451
|
+
use_case: "basic_create",
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
command: "f5xcctl secret_management decrypt-secret create -f {file}.yaml",
|
|
455
|
+
description: "Create from YAML file",
|
|
456
|
+
use_case: "file_based",
|
|
457
|
+
},
|
|
458
|
+
],
|
|
459
|
+
field_docs: {},
|
|
460
|
+
optional_fields: [],
|
|
461
|
+
performance_impact: {
|
|
462
|
+
latency: "low",
|
|
463
|
+
resource_usage: "low",
|
|
464
|
+
},
|
|
465
|
+
purpose: "Create new decrypt-secret",
|
|
466
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
467
|
+
side_effects: {
|
|
468
|
+
creates: ["decrypt-secret"],
|
|
469
|
+
},
|
|
470
|
+
},
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
toolName: "f5xc-api-blindfold-get-policy-document-get",
|
|
474
|
+
method: "GET",
|
|
475
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policys/{name}/get_policy_document",
|
|
476
|
+
operation: "get",
|
|
477
|
+
domain: "blindfold",
|
|
478
|
+
resource: "get-policy-document",
|
|
479
|
+
summary: "Policy Document.",
|
|
480
|
+
description: "GetPolicyDocument API returns secret policy document for the given policy that contains information about all the rules in the policy and policy_id.\nThis document can be given to F5 Distributed Cloud secret management tool to do secret encryption.",
|
|
481
|
+
pathParameters: [
|
|
482
|
+
{
|
|
483
|
+
description: "Name\n\nx-required\nName of the secret policy.",
|
|
484
|
+
in: "path",
|
|
485
|
+
name: "name",
|
|
486
|
+
required: true,
|
|
487
|
+
schema: {
|
|
488
|
+
type: "string",
|
|
489
|
+
},
|
|
490
|
+
"x-displayname": "Name",
|
|
491
|
+
"x-ves-example": "Site-secret-policy.",
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
description: "Namespace\n\nx-required\nNamespace of the secret policy.",
|
|
495
|
+
in: "path",
|
|
496
|
+
name: "namespace",
|
|
497
|
+
required: true,
|
|
498
|
+
schema: {
|
|
499
|
+
type: "string",
|
|
500
|
+
},
|
|
501
|
+
"x-displayname": "Namespace",
|
|
502
|
+
"x-ves-example": "System",
|
|
503
|
+
},
|
|
504
|
+
],
|
|
505
|
+
queryParameters: [],
|
|
506
|
+
requestBodySchema: null,
|
|
507
|
+
responseSchema: {
|
|
508
|
+
$ref: "#/components/schemas/secret_managementGetPolicyDocumentResponse",
|
|
509
|
+
},
|
|
510
|
+
requiredParams: ["name", "namespace"],
|
|
511
|
+
operationId: "ves.io.schema.secret_management.CustomAPI.GetPolicyDocument",
|
|
512
|
+
tags: ["Security"],
|
|
513
|
+
sourceFile: "domains/blindfold.json",
|
|
514
|
+
displayName: null,
|
|
515
|
+
dangerLevel: "low",
|
|
516
|
+
sideEffects: null,
|
|
517
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
518
|
+
cliExamples: [
|
|
519
|
+
{
|
|
520
|
+
command: "f5xcctl secret_management get-policy-document get {name} --namespace {namespace}",
|
|
521
|
+
description: "Get specific get-policy-document",
|
|
522
|
+
use_case: "get_specific",
|
|
523
|
+
},
|
|
524
|
+
],
|
|
525
|
+
confirmationRequired: false,
|
|
526
|
+
parameterExamples: {
|
|
527
|
+
name: "Site-secret-policy.",
|
|
528
|
+
namespace: "System",
|
|
529
|
+
},
|
|
530
|
+
validationRules: {},
|
|
531
|
+
operationMetadata: {
|
|
532
|
+
common_errors: [
|
|
533
|
+
{
|
|
534
|
+
code: 401,
|
|
535
|
+
message: "Authentication required",
|
|
536
|
+
solution: "Provide valid API credentials",
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
code: 403,
|
|
540
|
+
message: "Permission denied",
|
|
541
|
+
solution: "Check access permissions for this operation",
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
code: 404,
|
|
545
|
+
message: "Resource not found",
|
|
546
|
+
solution: "Verify resource name, namespace, and path",
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
code: 409,
|
|
550
|
+
message: "Resource already exists",
|
|
551
|
+
solution: "Use different name or update existing resource",
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
code: 429,
|
|
555
|
+
message: "Rate limit exceeded",
|
|
556
|
+
solution: "Wait before retrying the operation",
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
code: 500,
|
|
560
|
+
message: "Server error",
|
|
561
|
+
solution: "Retry operation or contact support",
|
|
562
|
+
},
|
|
563
|
+
],
|
|
564
|
+
conditions: {
|
|
565
|
+
postconditions: [],
|
|
566
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
567
|
+
},
|
|
568
|
+
confirmation_required: false,
|
|
569
|
+
danger_level: "low",
|
|
570
|
+
examples: [
|
|
571
|
+
{
|
|
572
|
+
command: "f5xcctl secret_management get-policy-document get {name} --namespace {namespace}",
|
|
573
|
+
description: "Get specific get-policy-document",
|
|
574
|
+
use_case: "get_specific",
|
|
575
|
+
},
|
|
576
|
+
],
|
|
577
|
+
field_docs: {},
|
|
578
|
+
optional_fields: [],
|
|
579
|
+
performance_impact: {
|
|
580
|
+
latency: "moderate",
|
|
581
|
+
resource_usage: "moderate",
|
|
582
|
+
},
|
|
583
|
+
purpose: "Retrieve specific get-policy-document",
|
|
584
|
+
required_fields: ["path.name", "path.namespace"],
|
|
585
|
+
side_effects: {},
|
|
586
|
+
},
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
toolName: "f5xc-api-blindfold-get-public-key-list",
|
|
590
|
+
method: "GET",
|
|
591
|
+
path: "/api/secret_management/get_public_key",
|
|
592
|
+
operation: "list",
|
|
593
|
+
domain: "blindfold",
|
|
594
|
+
resource: "get-public-key",
|
|
595
|
+
summary: "Public Key.",
|
|
596
|
+
description: "GetPublicKey API returns public part of the F5 Distributed Cloud secret management key that needs to be given to F5 Distributed Cloud secret management tool to do secret encryption.",
|
|
597
|
+
pathParameters: [],
|
|
598
|
+
queryParameters: [
|
|
599
|
+
{
|
|
600
|
+
description: "The version of public key.",
|
|
601
|
+
in: "query",
|
|
602
|
+
name: "key_version",
|
|
603
|
+
required: false,
|
|
604
|
+
schema: {
|
|
605
|
+
format: "int64",
|
|
606
|
+
type: "integer",
|
|
607
|
+
},
|
|
608
|
+
"x-displayname": "Key Version.",
|
|
609
|
+
"x-ves-example": "0",
|
|
610
|
+
},
|
|
611
|
+
],
|
|
612
|
+
requestBodySchema: null,
|
|
613
|
+
responseSchema: {
|
|
614
|
+
$ref: "#/components/schemas/secret_managementGetPublicKeyResponse",
|
|
615
|
+
},
|
|
616
|
+
requiredParams: [],
|
|
617
|
+
operationId: "ves.io.schema.secret_management.CustomAPI.GetPublicKey",
|
|
618
|
+
tags: ["Security"],
|
|
619
|
+
sourceFile: "domains/blindfold.json",
|
|
620
|
+
displayName: null,
|
|
621
|
+
dangerLevel: "low",
|
|
622
|
+
sideEffects: null,
|
|
623
|
+
requiredFields: [],
|
|
624
|
+
cliExamples: [
|
|
625
|
+
{
|
|
626
|
+
command: "f5xcctl secret_management get-public-key list --namespace {namespace}",
|
|
627
|
+
description: "List all get-public-keys",
|
|
628
|
+
use_case: "list_all",
|
|
629
|
+
},
|
|
630
|
+
],
|
|
631
|
+
confirmationRequired: false,
|
|
632
|
+
parameterExamples: {
|
|
633
|
+
key_version: "0",
|
|
634
|
+
},
|
|
635
|
+
validationRules: {},
|
|
636
|
+
operationMetadata: {
|
|
637
|
+
common_errors: [
|
|
638
|
+
{
|
|
639
|
+
code: 401,
|
|
640
|
+
message: "Authentication required",
|
|
641
|
+
solution: "Provide valid API credentials",
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
code: 403,
|
|
645
|
+
message: "Permission denied",
|
|
646
|
+
solution: "Check access permissions for this operation",
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
code: 404,
|
|
650
|
+
message: "Resource not found",
|
|
651
|
+
solution: "Verify resource name, namespace, and path",
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
code: 409,
|
|
655
|
+
message: "Resource already exists",
|
|
656
|
+
solution: "Use different name or update existing resource",
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
code: 429,
|
|
660
|
+
message: "Rate limit exceeded",
|
|
661
|
+
solution: "Wait before retrying the operation",
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
code: 500,
|
|
665
|
+
message: "Server error",
|
|
666
|
+
solution: "Retry operation or contact support",
|
|
667
|
+
},
|
|
668
|
+
],
|
|
669
|
+
conditions: {
|
|
670
|
+
postconditions: [],
|
|
671
|
+
prerequisites: [],
|
|
672
|
+
},
|
|
673
|
+
confirmation_required: false,
|
|
674
|
+
danger_level: "low",
|
|
675
|
+
examples: [
|
|
676
|
+
{
|
|
677
|
+
command: "f5xcctl secret_management get-public-key list --namespace {namespace}",
|
|
678
|
+
description: "List all get-public-keys",
|
|
679
|
+
use_case: "list_all",
|
|
680
|
+
},
|
|
681
|
+
],
|
|
682
|
+
field_docs: {},
|
|
683
|
+
optional_fields: [],
|
|
684
|
+
performance_impact: {
|
|
685
|
+
latency: "moderate",
|
|
686
|
+
resource_usage: "moderate",
|
|
687
|
+
},
|
|
688
|
+
purpose: "List all get-public-keys",
|
|
689
|
+
required_fields: [],
|
|
690
|
+
side_effects: {},
|
|
691
|
+
},
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
toolName: "f5xc-api-blindfold-list-policy-list",
|
|
695
|
+
method: "GET",
|
|
696
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy/list_policy/{policy_state}",
|
|
697
|
+
operation: "list",
|
|
698
|
+
domain: "blindfold",
|
|
699
|
+
resource: "list-policy",
|
|
700
|
+
summary: "List secret policy.",
|
|
701
|
+
description: "Listpolicy CustomAPI.",
|
|
702
|
+
pathParameters: [
|
|
703
|
+
{
|
|
704
|
+
description: "Namespace\n\nx-required\nNamespace of the secret policy.",
|
|
705
|
+
in: "path",
|
|
706
|
+
name: "namespace",
|
|
707
|
+
required: true,
|
|
708
|
+
schema: {
|
|
709
|
+
type: "string",
|
|
710
|
+
},
|
|
711
|
+
"x-displayname": "Namespace",
|
|
712
|
+
"x-ves-example": "System",
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
description: "Policy_state\n\nx-required\nstate of the policy to filter in results.",
|
|
716
|
+
in: "path",
|
|
717
|
+
name: "policy_state",
|
|
718
|
+
required: true,
|
|
719
|
+
schema: {
|
|
720
|
+
type: "string",
|
|
721
|
+
},
|
|
722
|
+
"x-displayname": "Policy_state.",
|
|
723
|
+
"x-ves-example": "All",
|
|
724
|
+
},
|
|
725
|
+
],
|
|
726
|
+
queryParameters: [],
|
|
727
|
+
requestBodySchema: null,
|
|
728
|
+
responseSchema: {
|
|
729
|
+
$ref: "#/components/schemas/secret_policyListPolicyResponse",
|
|
730
|
+
},
|
|
731
|
+
requiredParams: ["namespace", "policy_state"],
|
|
732
|
+
operationId: "ves.io.schema.secret_policy.CustomAPI.ListPolicy",
|
|
733
|
+
tags: ["Security"],
|
|
734
|
+
sourceFile: "domains/blindfold.json",
|
|
735
|
+
displayName: null,
|
|
736
|
+
dangerLevel: "low",
|
|
737
|
+
sideEffects: null,
|
|
738
|
+
requiredFields: ["path.namespace", "path.policy_state"],
|
|
739
|
+
cliExamples: [
|
|
740
|
+
{
|
|
741
|
+
command: "f5xcctl secret_management list-policy list --namespace {namespace}",
|
|
742
|
+
description: "List all list-policys",
|
|
743
|
+
use_case: "list_all",
|
|
744
|
+
},
|
|
745
|
+
],
|
|
746
|
+
confirmationRequired: false,
|
|
747
|
+
parameterExamples: {
|
|
748
|
+
namespace: "System",
|
|
749
|
+
policy_state: "All",
|
|
750
|
+
},
|
|
751
|
+
validationRules: {},
|
|
752
|
+
operationMetadata: {
|
|
753
|
+
common_errors: [
|
|
754
|
+
{
|
|
755
|
+
code: 401,
|
|
756
|
+
message: "Authentication required",
|
|
757
|
+
solution: "Provide valid API credentials",
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
code: 403,
|
|
761
|
+
message: "Permission denied",
|
|
762
|
+
solution: "Check access permissions for this operation",
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
code: 404,
|
|
766
|
+
message: "Resource not found",
|
|
767
|
+
solution: "Verify resource name, namespace, and path",
|
|
768
|
+
},
|
|
769
|
+
{
|
|
770
|
+
code: 409,
|
|
771
|
+
message: "Resource already exists",
|
|
772
|
+
solution: "Use different name or update existing resource",
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
code: 429,
|
|
776
|
+
message: "Rate limit exceeded",
|
|
777
|
+
solution: "Wait before retrying the operation",
|
|
778
|
+
},
|
|
779
|
+
{
|
|
780
|
+
code: 500,
|
|
781
|
+
message: "Server error",
|
|
782
|
+
solution: "Retry operation or contact support",
|
|
783
|
+
},
|
|
784
|
+
],
|
|
785
|
+
conditions: {
|
|
786
|
+
postconditions: [],
|
|
787
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
788
|
+
},
|
|
789
|
+
confirmation_required: false,
|
|
790
|
+
danger_level: "low",
|
|
791
|
+
examples: [
|
|
792
|
+
{
|
|
793
|
+
command: "f5xcctl secret_management list-policy list --namespace {namespace}",
|
|
794
|
+
description: "List all list-policys",
|
|
795
|
+
use_case: "list_all",
|
|
796
|
+
},
|
|
797
|
+
],
|
|
798
|
+
field_docs: {},
|
|
799
|
+
optional_fields: [],
|
|
800
|
+
performance_impact: {
|
|
801
|
+
latency: "low",
|
|
802
|
+
resource_usage: "low",
|
|
803
|
+
},
|
|
804
|
+
purpose: "List all list-policys",
|
|
805
|
+
required_fields: ["path.namespace", "path.policy_state"],
|
|
806
|
+
side_effects: {},
|
|
807
|
+
},
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
toolName: "f5xc-api-blindfold-process-policy-information-create",
|
|
811
|
+
method: "POST",
|
|
812
|
+
path: "/api/secret_management/namespaces/system/voltshare/process_policy_information",
|
|
813
|
+
operation: "create",
|
|
814
|
+
domain: "blindfold",
|
|
815
|
+
resource: "process-policy-information",
|
|
816
|
+
summary: "ProcessPolicyInformation.",
|
|
817
|
+
description: "ProcessPolicyInformation API takes policy and secret name as input and returns a document containing .",
|
|
818
|
+
pathParameters: [],
|
|
819
|
+
queryParameters: [],
|
|
820
|
+
requestBodySchema: {
|
|
821
|
+
$ref: "#/components/schemas/voltshareProcessPolicyRequest",
|
|
822
|
+
},
|
|
823
|
+
responseSchema: {
|
|
824
|
+
$ref: "#/components/schemas/voltshareProcessPolicyResponse",
|
|
825
|
+
},
|
|
826
|
+
requiredParams: ["body"],
|
|
827
|
+
operationId: "ves.io.schema.voltshare.CustomAPI.ProcessPolicyInformation",
|
|
828
|
+
tags: ["Security"],
|
|
829
|
+
sourceFile: "domains/blindfold.json",
|
|
830
|
+
displayName: null,
|
|
831
|
+
dangerLevel: "medium",
|
|
832
|
+
sideEffects: {
|
|
833
|
+
creates: ["process-policy-information"],
|
|
834
|
+
},
|
|
835
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
836
|
+
cliExamples: [
|
|
837
|
+
{
|
|
838
|
+
command: "f5xcctl secret_management process-policy-information create -f {file}.yaml",
|
|
839
|
+
description: "Create from YAML file",
|
|
840
|
+
use_case: "file_based",
|
|
841
|
+
},
|
|
842
|
+
{
|
|
843
|
+
command: "f5xcctl secret_management process-policy-information create {name} --namespace {namespace}",
|
|
844
|
+
description: "Create process-policy-information",
|
|
845
|
+
use_case: "basic_create",
|
|
846
|
+
},
|
|
847
|
+
],
|
|
848
|
+
confirmationRequired: false,
|
|
849
|
+
parameterExamples: {},
|
|
850
|
+
validationRules: {},
|
|
851
|
+
operationMetadata: {
|
|
852
|
+
common_errors: [
|
|
853
|
+
{
|
|
854
|
+
code: 401,
|
|
855
|
+
message: "Authentication required",
|
|
856
|
+
solution: "Provide valid API credentials",
|
|
857
|
+
},
|
|
858
|
+
{
|
|
859
|
+
code: 403,
|
|
860
|
+
message: "Permission denied",
|
|
861
|
+
solution: "Check access permissions for this operation",
|
|
862
|
+
},
|
|
863
|
+
{
|
|
864
|
+
code: 404,
|
|
865
|
+
message: "Resource not found",
|
|
866
|
+
solution: "Verify resource name, namespace, and path",
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
code: 409,
|
|
870
|
+
message: "Resource already exists",
|
|
871
|
+
solution: "Use different name or update existing resource",
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
code: 429,
|
|
875
|
+
message: "Rate limit exceeded",
|
|
876
|
+
solution: "Wait before retrying the operation",
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
code: 500,
|
|
880
|
+
message: "Server error",
|
|
881
|
+
solution: "Retry operation or contact support",
|
|
882
|
+
},
|
|
883
|
+
],
|
|
884
|
+
conditions: {
|
|
885
|
+
postconditions: [
|
|
886
|
+
"Process-policy-information resource created",
|
|
887
|
+
"Resource assigned unique identifier",
|
|
888
|
+
],
|
|
889
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
890
|
+
},
|
|
891
|
+
confirmation_required: false,
|
|
892
|
+
danger_level: "medium",
|
|
893
|
+
examples: [
|
|
894
|
+
{
|
|
895
|
+
command: "f5xcctl secret_management process-policy-information create {name} --namespace {namespace}",
|
|
896
|
+
description: "Create process-policy-information",
|
|
897
|
+
use_case: "basic_create",
|
|
898
|
+
},
|
|
899
|
+
{
|
|
900
|
+
command: "f5xcctl secret_management process-policy-information create -f {file}.yaml",
|
|
901
|
+
description: "Create from YAML file",
|
|
902
|
+
use_case: "file_based",
|
|
903
|
+
},
|
|
904
|
+
],
|
|
905
|
+
field_docs: {},
|
|
906
|
+
optional_fields: [],
|
|
907
|
+
performance_impact: {
|
|
908
|
+
latency: "low",
|
|
909
|
+
resource_usage: "low",
|
|
910
|
+
},
|
|
911
|
+
purpose: "Create new process-policy-information",
|
|
912
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
913
|
+
side_effects: {
|
|
914
|
+
creates: ["process-policy-information"],
|
|
915
|
+
},
|
|
916
|
+
},
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
toolName: "f5xc-api-blindfold-recover-create",
|
|
920
|
+
method: "POST",
|
|
921
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy/{name}/recover",
|
|
922
|
+
operation: "create",
|
|
923
|
+
domain: "blindfold",
|
|
924
|
+
resource: "recover",
|
|
925
|
+
summary: "Recover secret policy with given policy name.",
|
|
926
|
+
description: "Recoverpolicy CustomAPI.",
|
|
927
|
+
pathParameters: [
|
|
928
|
+
{
|
|
929
|
+
description: "Name\n\nx-required\nName of the secret policy.",
|
|
930
|
+
in: "path",
|
|
931
|
+
name: "name",
|
|
932
|
+
required: true,
|
|
933
|
+
schema: {
|
|
934
|
+
type: "string",
|
|
935
|
+
},
|
|
936
|
+
"x-displayname": "Name",
|
|
937
|
+
"x-ves-example": "Site-secret-policy.",
|
|
938
|
+
},
|
|
939
|
+
{
|
|
940
|
+
description: "Namespace\n\nx-required\nNamespace of the secret policy.",
|
|
941
|
+
in: "path",
|
|
942
|
+
name: "namespace",
|
|
943
|
+
required: true,
|
|
944
|
+
schema: {
|
|
945
|
+
type: "string",
|
|
946
|
+
},
|
|
947
|
+
"x-displayname": "Namespace",
|
|
948
|
+
"x-ves-example": "System",
|
|
949
|
+
},
|
|
950
|
+
],
|
|
951
|
+
queryParameters: [],
|
|
952
|
+
requestBodySchema: {
|
|
953
|
+
$ref: "#/components/schemas/secret_policyRecoverRequest",
|
|
954
|
+
},
|
|
955
|
+
responseSchema: {
|
|
956
|
+
$ref: "#/components/schemas/secret_policyRecoverResponse",
|
|
957
|
+
},
|
|
958
|
+
requiredParams: ["body", "name", "namespace"],
|
|
959
|
+
operationId: "ves.io.schema.secret_policy.CustomAPI.RecoverPolicy",
|
|
960
|
+
tags: ["Security"],
|
|
961
|
+
sourceFile: "domains/blindfold.json",
|
|
962
|
+
displayName: null,
|
|
963
|
+
dangerLevel: "medium",
|
|
964
|
+
sideEffects: {
|
|
965
|
+
creates: ["recover"],
|
|
966
|
+
},
|
|
967
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
968
|
+
cliExamples: [
|
|
969
|
+
{
|
|
970
|
+
command: "f5xcctl secret_management recover create -f {file}.yaml",
|
|
971
|
+
description: "Create from YAML file",
|
|
972
|
+
use_case: "file_based",
|
|
973
|
+
},
|
|
974
|
+
{
|
|
975
|
+
command: "f5xcctl secret_management recover create {name} --namespace {namespace}",
|
|
976
|
+
description: "Create recover",
|
|
977
|
+
use_case: "basic_create",
|
|
978
|
+
},
|
|
979
|
+
],
|
|
980
|
+
confirmationRequired: false,
|
|
981
|
+
parameterExamples: {
|
|
982
|
+
name: "Site-secret-policy.",
|
|
983
|
+
namespace: "System",
|
|
984
|
+
},
|
|
985
|
+
validationRules: {},
|
|
986
|
+
operationMetadata: {
|
|
987
|
+
common_errors: [
|
|
988
|
+
{
|
|
989
|
+
code: 401,
|
|
990
|
+
message: "Authentication required",
|
|
991
|
+
solution: "Provide valid API credentials",
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
code: 403,
|
|
995
|
+
message: "Permission denied",
|
|
996
|
+
solution: "Check access permissions for this operation",
|
|
997
|
+
},
|
|
998
|
+
{
|
|
999
|
+
code: 404,
|
|
1000
|
+
message: "Resource not found",
|
|
1001
|
+
solution: "Verify resource name, namespace, and path",
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
code: 409,
|
|
1005
|
+
message: "Resource already exists",
|
|
1006
|
+
solution: "Use different name or update existing resource",
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
code: 429,
|
|
1010
|
+
message: "Rate limit exceeded",
|
|
1011
|
+
solution: "Wait before retrying the operation",
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
code: 500,
|
|
1015
|
+
message: "Server error",
|
|
1016
|
+
solution: "Retry operation or contact support",
|
|
1017
|
+
},
|
|
1018
|
+
],
|
|
1019
|
+
conditions: {
|
|
1020
|
+
postconditions: ["Recover resource created", "Resource assigned unique identifier"],
|
|
1021
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1022
|
+
},
|
|
1023
|
+
confirmation_required: false,
|
|
1024
|
+
danger_level: "medium",
|
|
1025
|
+
examples: [
|
|
1026
|
+
{
|
|
1027
|
+
command: "f5xcctl secret_management recover create {name} --namespace {namespace}",
|
|
1028
|
+
description: "Create recover",
|
|
1029
|
+
use_case: "basic_create",
|
|
1030
|
+
},
|
|
1031
|
+
{
|
|
1032
|
+
command: "f5xcctl secret_management recover create -f {file}.yaml",
|
|
1033
|
+
description: "Create from YAML file",
|
|
1034
|
+
use_case: "file_based",
|
|
1035
|
+
},
|
|
1036
|
+
],
|
|
1037
|
+
field_docs: {},
|
|
1038
|
+
optional_fields: [],
|
|
1039
|
+
performance_impact: {
|
|
1040
|
+
latency: "low",
|
|
1041
|
+
resource_usage: "low",
|
|
1042
|
+
},
|
|
1043
|
+
purpose: "Create new recover",
|
|
1044
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
1045
|
+
side_effects: {
|
|
1046
|
+
creates: ["recover"],
|
|
1047
|
+
},
|
|
1048
|
+
},
|
|
1049
|
+
},
|
|
1050
|
+
{
|
|
1051
|
+
toolName: "f5xc-api-blindfold-scroll-create",
|
|
1052
|
+
method: "POST",
|
|
1053
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/scroll",
|
|
1054
|
+
operation: "create",
|
|
1055
|
+
domain: "blindfold",
|
|
1056
|
+
resource: "scroll",
|
|
1057
|
+
summary: "Audit Log Scroll Query.",
|
|
1058
|
+
description: "The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).",
|
|
1059
|
+
pathParameters: [
|
|
1060
|
+
{
|
|
1061
|
+
description: "Namespace\nfetch the log messages scoped by namespace.",
|
|
1062
|
+
in: "path",
|
|
1063
|
+
name: "namespace",
|
|
1064
|
+
required: true,
|
|
1065
|
+
schema: {
|
|
1066
|
+
type: "string",
|
|
1067
|
+
},
|
|
1068
|
+
"x-displayname": "Namespace",
|
|
1069
|
+
"x-ves-example": "Value",
|
|
1070
|
+
},
|
|
1071
|
+
],
|
|
1072
|
+
queryParameters: [],
|
|
1073
|
+
requestBodySchema: {
|
|
1074
|
+
$ref: "#/components/schemas/voltshareAuditLogScrollRequest",
|
|
1075
|
+
},
|
|
1076
|
+
responseSchema: {
|
|
1077
|
+
$ref: "#/components/schemas/voltshareAuditLogResponse",
|
|
1078
|
+
},
|
|
1079
|
+
requiredParams: ["body", "namespace"],
|
|
1080
|
+
operationId: "docs_cloud_f5_com_0109_public_ves_io_schema_voltshare_ves_swagger_ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery",
|
|
1081
|
+
tags: ["Security"],
|
|
1082
|
+
sourceFile: "domains/blindfold.json",
|
|
1083
|
+
displayName: null,
|
|
1084
|
+
dangerLevel: "medium",
|
|
1085
|
+
sideEffects: {
|
|
1086
|
+
creates: ["scroll"],
|
|
1087
|
+
},
|
|
1088
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1089
|
+
cliExamples: [
|
|
1090
|
+
{
|
|
1091
|
+
command: "f5xcctl secret_management scroll create -f {file}.yaml",
|
|
1092
|
+
description: "Create from YAML file",
|
|
1093
|
+
use_case: "file_based",
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
command: "f5xcctl secret_management scroll create {name} --namespace {namespace}",
|
|
1097
|
+
description: "Create scroll",
|
|
1098
|
+
use_case: "basic_create",
|
|
1099
|
+
},
|
|
1100
|
+
],
|
|
1101
|
+
confirmationRequired: false,
|
|
1102
|
+
parameterExamples: {
|
|
1103
|
+
namespace: "Value",
|
|
1104
|
+
},
|
|
1105
|
+
validationRules: {},
|
|
1106
|
+
operationMetadata: {
|
|
1107
|
+
common_errors: [
|
|
1108
|
+
{
|
|
1109
|
+
code: 401,
|
|
1110
|
+
message: "Authentication required",
|
|
1111
|
+
solution: "Provide valid API credentials",
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
code: 403,
|
|
1115
|
+
message: "Permission denied",
|
|
1116
|
+
solution: "Check access permissions for this operation",
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
code: 404,
|
|
1120
|
+
message: "Resource not found",
|
|
1121
|
+
solution: "Verify resource name, namespace, and path",
|
|
1122
|
+
},
|
|
1123
|
+
{
|
|
1124
|
+
code: 409,
|
|
1125
|
+
message: "Resource already exists",
|
|
1126
|
+
solution: "Use different name or update existing resource",
|
|
1127
|
+
},
|
|
1128
|
+
{
|
|
1129
|
+
code: 429,
|
|
1130
|
+
message: "Rate limit exceeded",
|
|
1131
|
+
solution: "Wait before retrying the operation",
|
|
1132
|
+
},
|
|
1133
|
+
{
|
|
1134
|
+
code: 500,
|
|
1135
|
+
message: "Server error",
|
|
1136
|
+
solution: "Retry operation or contact support",
|
|
1137
|
+
},
|
|
1138
|
+
],
|
|
1139
|
+
conditions: {
|
|
1140
|
+
postconditions: ["Scroll resource created", "Resource assigned unique identifier"],
|
|
1141
|
+
prerequisites: ["Active namespace"],
|
|
1142
|
+
},
|
|
1143
|
+
confirmation_required: false,
|
|
1144
|
+
danger_level: "medium",
|
|
1145
|
+
examples: [
|
|
1146
|
+
{
|
|
1147
|
+
command: "f5xcctl secret_management scroll create {name} --namespace {namespace}",
|
|
1148
|
+
description: "Create scroll",
|
|
1149
|
+
use_case: "basic_create",
|
|
1150
|
+
},
|
|
1151
|
+
{
|
|
1152
|
+
command: "f5xcctl secret_management scroll create -f {file}.yaml",
|
|
1153
|
+
description: "Create from YAML file",
|
|
1154
|
+
use_case: "file_based",
|
|
1155
|
+
},
|
|
1156
|
+
],
|
|
1157
|
+
field_docs: {},
|
|
1158
|
+
optional_fields: [],
|
|
1159
|
+
performance_impact: {
|
|
1160
|
+
latency: "low",
|
|
1161
|
+
resource_usage: "low",
|
|
1162
|
+
},
|
|
1163
|
+
purpose: "Create new scroll",
|
|
1164
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1165
|
+
side_effects: {
|
|
1166
|
+
creates: ["scroll"],
|
|
1167
|
+
},
|
|
1168
|
+
},
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
toolName: "f5xc-api-blindfold-scroll-list",
|
|
1172
|
+
method: "GET",
|
|
1173
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare/audit_logs/scroll",
|
|
1174
|
+
operation: "list",
|
|
1175
|
+
domain: "blindfold",
|
|
1176
|
+
resource: "scroll",
|
|
1177
|
+
summary: "Audit Log Scroll Query.",
|
|
1178
|
+
description: "The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).",
|
|
1179
|
+
pathParameters: [
|
|
1180
|
+
{
|
|
1181
|
+
description: "Namespace\nfetch the log messages scoped by namespace.",
|
|
1182
|
+
in: "path",
|
|
1183
|
+
name: "namespace",
|
|
1184
|
+
required: true,
|
|
1185
|
+
schema: {
|
|
1186
|
+
type: "string",
|
|
1187
|
+
},
|
|
1188
|
+
"x-displayname": "Namespace",
|
|
1189
|
+
"x-ves-example": "Value",
|
|
1190
|
+
},
|
|
1191
|
+
],
|
|
1192
|
+
queryParameters: [
|
|
1193
|
+
{
|
|
1194
|
+
description: "Long Base-64 encoded string which can be used to retrieve next batch of log messages.",
|
|
1195
|
+
in: "query",
|
|
1196
|
+
name: "scroll_id",
|
|
1197
|
+
required: false,
|
|
1198
|
+
schema: {
|
|
1199
|
+
type: "string",
|
|
1200
|
+
},
|
|
1201
|
+
"x-displayname": "Scroll ID",
|
|
1202
|
+
"x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
1203
|
+
},
|
|
1204
|
+
],
|
|
1205
|
+
requestBodySchema: null,
|
|
1206
|
+
responseSchema: {
|
|
1207
|
+
$ref: "#/components/schemas/voltshareAuditLogResponse",
|
|
1208
|
+
},
|
|
1209
|
+
requiredParams: ["namespace"],
|
|
1210
|
+
operationId: "ves.io.schema.voltshare.MonitoringAPI.AuditLogScrollQuery",
|
|
1211
|
+
tags: ["Security"],
|
|
1212
|
+
sourceFile: "domains/blindfold.json",
|
|
1213
|
+
displayName: null,
|
|
1214
|
+
dangerLevel: "low",
|
|
1215
|
+
sideEffects: null,
|
|
1216
|
+
requiredFields: ["path.namespace"],
|
|
1217
|
+
cliExamples: [
|
|
1218
|
+
{
|
|
1219
|
+
command: "f5xcctl secret_management scroll list --namespace {namespace}",
|
|
1220
|
+
description: "List all scrolls",
|
|
1221
|
+
use_case: "list_all",
|
|
1222
|
+
},
|
|
1223
|
+
],
|
|
1224
|
+
confirmationRequired: false,
|
|
1225
|
+
parameterExamples: {
|
|
1226
|
+
namespace: "Value",
|
|
1227
|
+
scroll_id: "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.",
|
|
1228
|
+
},
|
|
1229
|
+
validationRules: {},
|
|
1230
|
+
operationMetadata: {
|
|
1231
|
+
common_errors: [
|
|
1232
|
+
{
|
|
1233
|
+
code: 401,
|
|
1234
|
+
message: "Authentication required",
|
|
1235
|
+
solution: "Provide valid API credentials",
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
code: 403,
|
|
1239
|
+
message: "Permission denied",
|
|
1240
|
+
solution: "Check access permissions for this operation",
|
|
1241
|
+
},
|
|
1242
|
+
{
|
|
1243
|
+
code: 404,
|
|
1244
|
+
message: "Resource not found",
|
|
1245
|
+
solution: "Verify resource name, namespace, and path",
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
code: 409,
|
|
1249
|
+
message: "Resource already exists",
|
|
1250
|
+
solution: "Use different name or update existing resource",
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
code: 429,
|
|
1254
|
+
message: "Rate limit exceeded",
|
|
1255
|
+
solution: "Wait before retrying the operation",
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
code: 500,
|
|
1259
|
+
message: "Server error",
|
|
1260
|
+
solution: "Retry operation or contact support",
|
|
1261
|
+
},
|
|
1262
|
+
],
|
|
1263
|
+
conditions: {
|
|
1264
|
+
postconditions: [],
|
|
1265
|
+
prerequisites: ["Active namespace"],
|
|
1266
|
+
},
|
|
1267
|
+
confirmation_required: false,
|
|
1268
|
+
danger_level: "low",
|
|
1269
|
+
examples: [
|
|
1270
|
+
{
|
|
1271
|
+
command: "f5xcctl secret_management scroll list --namespace {namespace}",
|
|
1272
|
+
description: "List all scrolls",
|
|
1273
|
+
use_case: "list_all",
|
|
1274
|
+
},
|
|
1275
|
+
],
|
|
1276
|
+
field_docs: {},
|
|
1277
|
+
optional_fields: [],
|
|
1278
|
+
performance_impact: {
|
|
1279
|
+
latency: "moderate",
|
|
1280
|
+
resource_usage: "moderate",
|
|
1281
|
+
},
|
|
1282
|
+
purpose: "List all scrolls",
|
|
1283
|
+
required_fields: ["path.namespace"],
|
|
1284
|
+
side_effects: {},
|
|
1285
|
+
},
|
|
1286
|
+
},
|
|
1287
|
+
{
|
|
1288
|
+
toolName: "f5xc-api-blindfold-secret-management-access-create",
|
|
1289
|
+
method: "POST",
|
|
1290
|
+
path: "/api/config/namespaces/{metadata.namespace}/secret_management_accesss",
|
|
1291
|
+
operation: "create",
|
|
1292
|
+
domain: "blindfold",
|
|
1293
|
+
resource: "secret-management-access",
|
|
1294
|
+
summary: "Create Secret Management Access.",
|
|
1295
|
+
description: "Create secret_management_access creates a new object in storage backend for metadata.namespace.",
|
|
1296
|
+
pathParameters: [
|
|
1297
|
+
{
|
|
1298
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1299
|
+
in: "path",
|
|
1300
|
+
name: "metadata.namespace",
|
|
1301
|
+
required: true,
|
|
1302
|
+
schema: {
|
|
1303
|
+
type: "string",
|
|
1304
|
+
},
|
|
1305
|
+
"x-displayname": "Namespace",
|
|
1306
|
+
"x-ves-example": "Staging",
|
|
1307
|
+
},
|
|
1308
|
+
],
|
|
1309
|
+
queryParameters: [],
|
|
1310
|
+
requestBodySchema: {
|
|
1311
|
+
$ref: "#/components/schemas/secret_management_accessCreateRequest",
|
|
1312
|
+
},
|
|
1313
|
+
responseSchema: {
|
|
1314
|
+
$ref: "#/components/schemas/secret_management_accessCreateResponse",
|
|
1315
|
+
},
|
|
1316
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1317
|
+
operationId: "ves.io.schema.secret_management_access.API.Create",
|
|
1318
|
+
tags: ["Other"],
|
|
1319
|
+
sourceFile: "domains/blindfold.json",
|
|
1320
|
+
displayName: null,
|
|
1321
|
+
dangerLevel: "medium",
|
|
1322
|
+
sideEffects: {
|
|
1323
|
+
creates: ["secret-management-access"],
|
|
1324
|
+
},
|
|
1325
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1326
|
+
cliExamples: [
|
|
1327
|
+
{
|
|
1328
|
+
command: "f5xcctl config secret-management-access create -f {file}.yaml",
|
|
1329
|
+
description: "Create from YAML file",
|
|
1330
|
+
use_case: "file_based",
|
|
1331
|
+
},
|
|
1332
|
+
{
|
|
1333
|
+
command: "f5xcctl config secret-management-access create {name} --namespace {namespace}",
|
|
1334
|
+
description: "Create secret-management-access",
|
|
1335
|
+
use_case: "basic_create",
|
|
1336
|
+
},
|
|
1337
|
+
],
|
|
1338
|
+
confirmationRequired: false,
|
|
1339
|
+
parameterExamples: {
|
|
1340
|
+
"metadata.namespace": "Staging",
|
|
1341
|
+
},
|
|
1342
|
+
validationRules: {},
|
|
1343
|
+
operationMetadata: {
|
|
1344
|
+
common_errors: [
|
|
1345
|
+
{
|
|
1346
|
+
code: 401,
|
|
1347
|
+
message: "Authentication required",
|
|
1348
|
+
solution: "Provide valid API credentials",
|
|
1349
|
+
},
|
|
1350
|
+
{
|
|
1351
|
+
code: 403,
|
|
1352
|
+
message: "Permission denied",
|
|
1353
|
+
solution: "Check access permissions for this operation",
|
|
1354
|
+
},
|
|
1355
|
+
{
|
|
1356
|
+
code: 404,
|
|
1357
|
+
message: "Resource not found",
|
|
1358
|
+
solution: "Verify resource name, namespace, and path",
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
code: 409,
|
|
1362
|
+
message: "Resource already exists",
|
|
1363
|
+
solution: "Use different name or update existing resource",
|
|
1364
|
+
},
|
|
1365
|
+
{
|
|
1366
|
+
code: 429,
|
|
1367
|
+
message: "Rate limit exceeded",
|
|
1368
|
+
solution: "Wait before retrying the operation",
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
code: 500,
|
|
1372
|
+
message: "Server error",
|
|
1373
|
+
solution: "Retry operation or contact support",
|
|
1374
|
+
},
|
|
1375
|
+
],
|
|
1376
|
+
conditions: {
|
|
1377
|
+
postconditions: [
|
|
1378
|
+
"Secret-management-access resource created",
|
|
1379
|
+
"Resource assigned unique identifier",
|
|
1380
|
+
],
|
|
1381
|
+
prerequisites: ["Active namespace"],
|
|
1382
|
+
},
|
|
1383
|
+
confirmation_required: false,
|
|
1384
|
+
danger_level: "medium",
|
|
1385
|
+
examples: [
|
|
1386
|
+
{
|
|
1387
|
+
command: "f5xcctl config secret-management-access create {name} --namespace {namespace}",
|
|
1388
|
+
description: "Create secret-management-access",
|
|
1389
|
+
use_case: "basic_create",
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
command: "f5xcctl config secret-management-access create -f {file}.yaml",
|
|
1393
|
+
description: "Create from YAML file",
|
|
1394
|
+
use_case: "file_based",
|
|
1395
|
+
},
|
|
1396
|
+
],
|
|
1397
|
+
field_docs: {},
|
|
1398
|
+
optional_fields: [],
|
|
1399
|
+
performance_impact: {
|
|
1400
|
+
latency: "low",
|
|
1401
|
+
resource_usage: "low",
|
|
1402
|
+
},
|
|
1403
|
+
purpose: "Create new secret-management-access",
|
|
1404
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1405
|
+
side_effects: {
|
|
1406
|
+
creates: ["secret-management-access"],
|
|
1407
|
+
},
|
|
1408
|
+
},
|
|
1409
|
+
},
|
|
1410
|
+
{
|
|
1411
|
+
toolName: "f5xc-api-blindfold-secret-management-access-delete",
|
|
1412
|
+
method: "DELETE",
|
|
1413
|
+
path: "/api/config/namespaces/{namespace}/secret_management_accesss/{name}",
|
|
1414
|
+
operation: "delete",
|
|
1415
|
+
domain: "blindfold",
|
|
1416
|
+
resource: "secret-management-access",
|
|
1417
|
+
summary: "DELETE Secret Management Access.",
|
|
1418
|
+
description: "DELETE the specified secret_management_access.",
|
|
1419
|
+
pathParameters: [
|
|
1420
|
+
{
|
|
1421
|
+
description: "Name\nName of the configuration object.",
|
|
1422
|
+
in: "path",
|
|
1423
|
+
name: "name",
|
|
1424
|
+
required: true,
|
|
1425
|
+
schema: {
|
|
1426
|
+
type: "string",
|
|
1427
|
+
},
|
|
1428
|
+
"x-displayname": "Name",
|
|
1429
|
+
"x-ves-example": "Name",
|
|
1430
|
+
},
|
|
1431
|
+
{
|
|
1432
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1433
|
+
in: "path",
|
|
1434
|
+
name: "namespace",
|
|
1435
|
+
required: true,
|
|
1436
|
+
schema: {
|
|
1437
|
+
type: "string",
|
|
1438
|
+
},
|
|
1439
|
+
"x-displayname": "Namespace",
|
|
1440
|
+
"x-ves-example": "Ns1",
|
|
1441
|
+
},
|
|
1442
|
+
],
|
|
1443
|
+
queryParameters: [],
|
|
1444
|
+
requestBodySchema: {
|
|
1445
|
+
$ref: "#/components/schemas/secret_management_accessDeleteRequest",
|
|
1446
|
+
},
|
|
1447
|
+
responseSchema: {},
|
|
1448
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1449
|
+
operationId: "ves.io.schema.secret_management_access.API.Delete",
|
|
1450
|
+
tags: ["Other"],
|
|
1451
|
+
sourceFile: "domains/blindfold.json",
|
|
1452
|
+
displayName: null,
|
|
1453
|
+
dangerLevel: "high",
|
|
1454
|
+
sideEffects: {
|
|
1455
|
+
deletes: ["secret-management-access", "contained_resources"],
|
|
1456
|
+
},
|
|
1457
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1458
|
+
cliExamples: [
|
|
1459
|
+
{
|
|
1460
|
+
command: "f5xcctl config secret-management-access delete {name} --namespace {namespace}",
|
|
1461
|
+
description: "Delete secret-management-access",
|
|
1462
|
+
use_case: "delete",
|
|
1463
|
+
},
|
|
1464
|
+
],
|
|
1465
|
+
confirmationRequired: true,
|
|
1466
|
+
parameterExamples: {
|
|
1467
|
+
name: "Name",
|
|
1468
|
+
namespace: "Ns1",
|
|
1469
|
+
},
|
|
1470
|
+
validationRules: {},
|
|
1471
|
+
operationMetadata: {
|
|
1472
|
+
common_errors: [
|
|
1473
|
+
{
|
|
1474
|
+
code: 401,
|
|
1475
|
+
message: "Authentication required",
|
|
1476
|
+
solution: "Provide valid API credentials",
|
|
1477
|
+
},
|
|
1478
|
+
{
|
|
1479
|
+
code: 403,
|
|
1480
|
+
message: "Permission denied",
|
|
1481
|
+
solution: "Check access permissions for this operation",
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
code: 404,
|
|
1485
|
+
message: "Resource not found",
|
|
1486
|
+
solution: "Verify resource name, namespace, and path",
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
code: 409,
|
|
1490
|
+
message: "Resource already exists",
|
|
1491
|
+
solution: "Use different name or update existing resource",
|
|
1492
|
+
},
|
|
1493
|
+
{
|
|
1494
|
+
code: 429,
|
|
1495
|
+
message: "Rate limit exceeded",
|
|
1496
|
+
solution: "Wait before retrying the operation",
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
code: 500,
|
|
1500
|
+
message: "Server error",
|
|
1501
|
+
solution: "Retry operation or contact support",
|
|
1502
|
+
},
|
|
1503
|
+
],
|
|
1504
|
+
conditions: {
|
|
1505
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1506
|
+
prerequisites: ["Active namespace"],
|
|
1507
|
+
},
|
|
1508
|
+
confirmation_required: true,
|
|
1509
|
+
danger_level: "high",
|
|
1510
|
+
examples: [
|
|
1511
|
+
{
|
|
1512
|
+
command: "f5xcctl config secret-management-access delete {name} --namespace {namespace}",
|
|
1513
|
+
description: "Delete secret-management-access",
|
|
1514
|
+
use_case: "delete",
|
|
1515
|
+
},
|
|
1516
|
+
],
|
|
1517
|
+
field_docs: {},
|
|
1518
|
+
optional_fields: [],
|
|
1519
|
+
performance_impact: {
|
|
1520
|
+
latency: "high",
|
|
1521
|
+
resource_usage: "moderate",
|
|
1522
|
+
},
|
|
1523
|
+
purpose: "Delete secret-management-access",
|
|
1524
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1525
|
+
side_effects: {
|
|
1526
|
+
deletes: ["secret-management-access", "contained_resources"],
|
|
1527
|
+
},
|
|
1528
|
+
},
|
|
1529
|
+
},
|
|
1530
|
+
{
|
|
1531
|
+
toolName: "f5xc-api-blindfold-secret-management-access-get",
|
|
1532
|
+
method: "GET",
|
|
1533
|
+
path: "/api/config/namespaces/{namespace}/secret_management_accesss/{name}",
|
|
1534
|
+
operation: "get",
|
|
1535
|
+
domain: "blindfold",
|
|
1536
|
+
resource: "secret-management-access",
|
|
1537
|
+
summary: "GET Secret Management Access.",
|
|
1538
|
+
description: "GET secret_management_access reads a given object from storage backend for metadata.namespace.",
|
|
1539
|
+
pathParameters: [
|
|
1540
|
+
{
|
|
1541
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1542
|
+
in: "path",
|
|
1543
|
+
name: "name",
|
|
1544
|
+
required: true,
|
|
1545
|
+
schema: {
|
|
1546
|
+
type: "string",
|
|
1547
|
+
},
|
|
1548
|
+
"x-displayname": "Name",
|
|
1549
|
+
"x-ves-example": "Name",
|
|
1550
|
+
},
|
|
1551
|
+
{
|
|
1552
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1553
|
+
in: "path",
|
|
1554
|
+
name: "namespace",
|
|
1555
|
+
required: true,
|
|
1556
|
+
schema: {
|
|
1557
|
+
type: "string",
|
|
1558
|
+
},
|
|
1559
|
+
"x-displayname": "Namespace",
|
|
1560
|
+
"x-ves-example": "Ns1",
|
|
1561
|
+
},
|
|
1562
|
+
],
|
|
1563
|
+
queryParameters: [
|
|
1564
|
+
{
|
|
1565
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
1566
|
+
in: "query",
|
|
1567
|
+
name: "response_format",
|
|
1568
|
+
required: false,
|
|
1569
|
+
schema: {
|
|
1570
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1571
|
+
enum: [
|
|
1572
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1573
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1574
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1575
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1576
|
+
"GET_RSP_FORMAT_READ",
|
|
1577
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1578
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1579
|
+
],
|
|
1580
|
+
type: "string",
|
|
1581
|
+
},
|
|
1582
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1583
|
+
},
|
|
1584
|
+
],
|
|
1585
|
+
requestBodySchema: null,
|
|
1586
|
+
responseSchema: {
|
|
1587
|
+
$ref: "#/components/schemas/secret_management_accessGetResponse",
|
|
1588
|
+
},
|
|
1589
|
+
requiredParams: ["name", "namespace"],
|
|
1590
|
+
operationId: "ves.io.schema.secret_management_access.API.Get",
|
|
1591
|
+
tags: ["Other"],
|
|
1592
|
+
sourceFile: "domains/blindfold.json",
|
|
1593
|
+
displayName: null,
|
|
1594
|
+
dangerLevel: "low",
|
|
1595
|
+
sideEffects: null,
|
|
1596
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1597
|
+
cliExamples: [
|
|
1598
|
+
{
|
|
1599
|
+
command: "f5xcctl config secret-management-access get {name} --namespace {namespace}",
|
|
1600
|
+
description: "Get specific secret-management-access",
|
|
1601
|
+
use_case: "get_specific",
|
|
1602
|
+
},
|
|
1603
|
+
],
|
|
1604
|
+
confirmationRequired: false,
|
|
1605
|
+
parameterExamples: {
|
|
1606
|
+
name: "Name",
|
|
1607
|
+
namespace: "Ns1",
|
|
1608
|
+
},
|
|
1609
|
+
validationRules: {},
|
|
1610
|
+
operationMetadata: {
|
|
1611
|
+
common_errors: [
|
|
1612
|
+
{
|
|
1613
|
+
code: 401,
|
|
1614
|
+
message: "Authentication required",
|
|
1615
|
+
solution: "Provide valid API credentials",
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
code: 403,
|
|
1619
|
+
message: "Permission denied",
|
|
1620
|
+
solution: "Check access permissions for this operation",
|
|
1621
|
+
},
|
|
1622
|
+
{
|
|
1623
|
+
code: 404,
|
|
1624
|
+
message: "Resource not found",
|
|
1625
|
+
solution: "Verify resource name, namespace, and path",
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
code: 409,
|
|
1629
|
+
message: "Resource already exists",
|
|
1630
|
+
solution: "Use different name or update existing resource",
|
|
1631
|
+
},
|
|
1632
|
+
{
|
|
1633
|
+
code: 429,
|
|
1634
|
+
message: "Rate limit exceeded",
|
|
1635
|
+
solution: "Wait before retrying the operation",
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
code: 500,
|
|
1639
|
+
message: "Server error",
|
|
1640
|
+
solution: "Retry operation or contact support",
|
|
1641
|
+
},
|
|
1642
|
+
],
|
|
1643
|
+
conditions: {
|
|
1644
|
+
postconditions: [],
|
|
1645
|
+
prerequisites: ["Active namespace"],
|
|
1646
|
+
},
|
|
1647
|
+
confirmation_required: false,
|
|
1648
|
+
danger_level: "low",
|
|
1649
|
+
examples: [
|
|
1650
|
+
{
|
|
1651
|
+
command: "f5xcctl config secret-management-access get {name} --namespace {namespace}",
|
|
1652
|
+
description: "Get specific secret-management-access",
|
|
1653
|
+
use_case: "get_specific",
|
|
1654
|
+
},
|
|
1655
|
+
],
|
|
1656
|
+
field_docs: {},
|
|
1657
|
+
optional_fields: [],
|
|
1658
|
+
performance_impact: {
|
|
1659
|
+
latency: "low",
|
|
1660
|
+
resource_usage: "low",
|
|
1661
|
+
},
|
|
1662
|
+
purpose: "Retrieve specific secret-management-access",
|
|
1663
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1664
|
+
side_effects: {},
|
|
1665
|
+
},
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
toolName: "f5xc-api-blindfold-secret-management-access-list",
|
|
1669
|
+
method: "GET",
|
|
1670
|
+
path: "/api/config/namespaces/{namespace}/secret_management_accesss",
|
|
1671
|
+
operation: "list",
|
|
1672
|
+
domain: "blindfold",
|
|
1673
|
+
resource: "secret-management-access",
|
|
1674
|
+
summary: "List Secret Management Access.",
|
|
1675
|
+
description: "List the set of secret_management_access in a namespace.",
|
|
1676
|
+
pathParameters: [
|
|
1677
|
+
{
|
|
1678
|
+
description: "Namespace\nNamespace to scope the listing of secret_management_access.",
|
|
1679
|
+
in: "path",
|
|
1680
|
+
name: "namespace",
|
|
1681
|
+
required: true,
|
|
1682
|
+
schema: {
|
|
1683
|
+
type: "string",
|
|
1684
|
+
},
|
|
1685
|
+
"x-displayname": "Namespace",
|
|
1686
|
+
"x-ves-example": "Ns1",
|
|
1687
|
+
},
|
|
1688
|
+
],
|
|
1689
|
+
queryParameters: [
|
|
1690
|
+
{
|
|
1691
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1692
|
+
in: "query",
|
|
1693
|
+
name: "label_filter",
|
|
1694
|
+
required: false,
|
|
1695
|
+
schema: {
|
|
1696
|
+
type: "string",
|
|
1697
|
+
},
|
|
1698
|
+
"x-displayname": "Label Filter.",
|
|
1699
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1703
|
+
in: "query",
|
|
1704
|
+
name: "report_fields",
|
|
1705
|
+
required: false,
|
|
1706
|
+
schema: {
|
|
1707
|
+
items: {
|
|
1708
|
+
type: "string",
|
|
1709
|
+
},
|
|
1710
|
+
type: "array",
|
|
1711
|
+
},
|
|
1712
|
+
"x-displayname": "Report Fields.",
|
|
1713
|
+
},
|
|
1714
|
+
{
|
|
1715
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1716
|
+
in: "query",
|
|
1717
|
+
name: "report_status_fields",
|
|
1718
|
+
required: false,
|
|
1719
|
+
schema: {
|
|
1720
|
+
items: {
|
|
1721
|
+
type: "string",
|
|
1722
|
+
},
|
|
1723
|
+
type: "array",
|
|
1724
|
+
},
|
|
1725
|
+
"x-displayname": "Report Status Fields.",
|
|
1726
|
+
},
|
|
1727
|
+
],
|
|
1728
|
+
requestBodySchema: null,
|
|
1729
|
+
responseSchema: {
|
|
1730
|
+
$ref: "#/components/schemas/secret_management_accessListResponse",
|
|
1731
|
+
},
|
|
1732
|
+
requiredParams: ["namespace"],
|
|
1733
|
+
operationId: "ves.io.schema.secret_management_access.API.List",
|
|
1734
|
+
tags: ["Other"],
|
|
1735
|
+
sourceFile: "domains/blindfold.json",
|
|
1736
|
+
displayName: null,
|
|
1737
|
+
dangerLevel: "low",
|
|
1738
|
+
sideEffects: null,
|
|
1739
|
+
requiredFields: ["path.namespace"],
|
|
1740
|
+
cliExamples: [
|
|
1741
|
+
{
|
|
1742
|
+
command: "f5xcctl config secret-management-access list --namespace {namespace}",
|
|
1743
|
+
description: "List all secret-management-accesss",
|
|
1744
|
+
use_case: "list_all",
|
|
1745
|
+
},
|
|
1746
|
+
],
|
|
1747
|
+
confirmationRequired: false,
|
|
1748
|
+
parameterExamples: {
|
|
1749
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1750
|
+
namespace: "Ns1",
|
|
1751
|
+
},
|
|
1752
|
+
validationRules: {},
|
|
1753
|
+
operationMetadata: {
|
|
1754
|
+
common_errors: [
|
|
1755
|
+
{
|
|
1756
|
+
code: 401,
|
|
1757
|
+
message: "Authentication required",
|
|
1758
|
+
solution: "Provide valid API credentials",
|
|
1759
|
+
},
|
|
1760
|
+
{
|
|
1761
|
+
code: 403,
|
|
1762
|
+
message: "Permission denied",
|
|
1763
|
+
solution: "Check access permissions for this operation",
|
|
1764
|
+
},
|
|
1765
|
+
{
|
|
1766
|
+
code: 404,
|
|
1767
|
+
message: "Resource not found",
|
|
1768
|
+
solution: "Verify resource name, namespace, and path",
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
code: 409,
|
|
1772
|
+
message: "Resource already exists",
|
|
1773
|
+
solution: "Use different name or update existing resource",
|
|
1774
|
+
},
|
|
1775
|
+
{
|
|
1776
|
+
code: 429,
|
|
1777
|
+
message: "Rate limit exceeded",
|
|
1778
|
+
solution: "Wait before retrying the operation",
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
code: 500,
|
|
1782
|
+
message: "Server error",
|
|
1783
|
+
solution: "Retry operation or contact support",
|
|
1784
|
+
},
|
|
1785
|
+
],
|
|
1786
|
+
conditions: {
|
|
1787
|
+
postconditions: [],
|
|
1788
|
+
prerequisites: ["Active namespace"],
|
|
1789
|
+
},
|
|
1790
|
+
confirmation_required: false,
|
|
1791
|
+
danger_level: "low",
|
|
1792
|
+
examples: [
|
|
1793
|
+
{
|
|
1794
|
+
command: "f5xcctl config secret-management-access list --namespace {namespace}",
|
|
1795
|
+
description: "List all secret-management-accesss",
|
|
1796
|
+
use_case: "list_all",
|
|
1797
|
+
},
|
|
1798
|
+
],
|
|
1799
|
+
field_docs: {},
|
|
1800
|
+
optional_fields: [],
|
|
1801
|
+
performance_impact: {
|
|
1802
|
+
latency: "moderate",
|
|
1803
|
+
resource_usage: "moderate",
|
|
1804
|
+
},
|
|
1805
|
+
purpose: "List all secret-management-accesss",
|
|
1806
|
+
required_fields: ["path.namespace"],
|
|
1807
|
+
side_effects: {},
|
|
1808
|
+
},
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
toolName: "f5xc-api-blindfold-secret-management-access-update",
|
|
1812
|
+
method: "PUT",
|
|
1813
|
+
path: "/api/config/namespaces/{metadata.namespace}/secret_management_accesss/{metadata.name}",
|
|
1814
|
+
operation: "update",
|
|
1815
|
+
domain: "blindfold",
|
|
1816
|
+
resource: "secret-management-access",
|
|
1817
|
+
summary: "Replace Secret Management Access.",
|
|
1818
|
+
description: "Replace secret_management_access replaces an existing object in storage backend for metadata.namespace.",
|
|
1819
|
+
pathParameters: [
|
|
1820
|
+
{
|
|
1821
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1822
|
+
in: "path",
|
|
1823
|
+
name: "metadata.name",
|
|
1824
|
+
required: true,
|
|
1825
|
+
schema: {
|
|
1826
|
+
type: "string",
|
|
1827
|
+
},
|
|
1828
|
+
"x-displayname": "Name",
|
|
1829
|
+
"x-ves-example": "Example-corp-web.",
|
|
1830
|
+
},
|
|
1831
|
+
{
|
|
1832
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1833
|
+
in: "path",
|
|
1834
|
+
name: "metadata.namespace",
|
|
1835
|
+
required: true,
|
|
1836
|
+
schema: {
|
|
1837
|
+
type: "string",
|
|
1838
|
+
},
|
|
1839
|
+
"x-displayname": "Namespace",
|
|
1840
|
+
"x-ves-example": "Staging",
|
|
1841
|
+
},
|
|
1842
|
+
],
|
|
1843
|
+
queryParameters: [],
|
|
1844
|
+
requestBodySchema: {
|
|
1845
|
+
$ref: "#/components/schemas/secret_management_accessReplaceRequest",
|
|
1846
|
+
},
|
|
1847
|
+
responseSchema: {
|
|
1848
|
+
$ref: "#/components/schemas/secret_management_accessReplaceResponse",
|
|
1849
|
+
},
|
|
1850
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1851
|
+
operationId: "ves.io.schema.secret_management_access.API.Replace",
|
|
1852
|
+
tags: ["Other"],
|
|
1853
|
+
sourceFile: "domains/blindfold.json",
|
|
1854
|
+
displayName: null,
|
|
1855
|
+
dangerLevel: "medium",
|
|
1856
|
+
sideEffects: {
|
|
1857
|
+
modifies: ["secret-management-access"],
|
|
1858
|
+
},
|
|
1859
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1860
|
+
cliExamples: [
|
|
1861
|
+
{
|
|
1862
|
+
command: "f5xcctl config secret-management-access update {name} --namespace {namespace} -f {file}.yaml",
|
|
1863
|
+
description: "Update secret-management-access",
|
|
1864
|
+
use_case: "update",
|
|
1865
|
+
},
|
|
1866
|
+
],
|
|
1867
|
+
confirmationRequired: false,
|
|
1868
|
+
parameterExamples: {
|
|
1869
|
+
"metadata.name": "Example-corp-web.",
|
|
1870
|
+
"metadata.namespace": "Staging",
|
|
1871
|
+
},
|
|
1872
|
+
validationRules: {},
|
|
1873
|
+
operationMetadata: {
|
|
1874
|
+
common_errors: [
|
|
1875
|
+
{
|
|
1876
|
+
code: 401,
|
|
1877
|
+
message: "Authentication required",
|
|
1878
|
+
solution: "Provide valid API credentials",
|
|
1879
|
+
},
|
|
1880
|
+
{
|
|
1881
|
+
code: 403,
|
|
1882
|
+
message: "Permission denied",
|
|
1883
|
+
solution: "Check access permissions for this operation",
|
|
1884
|
+
},
|
|
1885
|
+
{
|
|
1886
|
+
code: 404,
|
|
1887
|
+
message: "Resource not found",
|
|
1888
|
+
solution: "Verify resource name, namespace, and path",
|
|
1889
|
+
},
|
|
1890
|
+
{
|
|
1891
|
+
code: 409,
|
|
1892
|
+
message: "Resource already exists",
|
|
1893
|
+
solution: "Use different name or update existing resource",
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
code: 429,
|
|
1897
|
+
message: "Rate limit exceeded",
|
|
1898
|
+
solution: "Wait before retrying the operation",
|
|
1899
|
+
},
|
|
1900
|
+
{
|
|
1901
|
+
code: 500,
|
|
1902
|
+
message: "Server error",
|
|
1903
|
+
solution: "Retry operation or contact support",
|
|
1904
|
+
},
|
|
1905
|
+
],
|
|
1906
|
+
conditions: {
|
|
1907
|
+
postconditions: ["Resource updated with new values"],
|
|
1908
|
+
prerequisites: ["Active namespace"],
|
|
1909
|
+
},
|
|
1910
|
+
confirmation_required: false,
|
|
1911
|
+
danger_level: "medium",
|
|
1912
|
+
examples: [
|
|
1913
|
+
{
|
|
1914
|
+
command: "f5xcctl config secret-management-access update {name} --namespace {namespace} -f {file}.yaml",
|
|
1915
|
+
description: "Update secret-management-access",
|
|
1916
|
+
use_case: "update",
|
|
1917
|
+
},
|
|
1918
|
+
],
|
|
1919
|
+
field_docs: {},
|
|
1920
|
+
optional_fields: [],
|
|
1921
|
+
performance_impact: {
|
|
1922
|
+
latency: "low",
|
|
1923
|
+
resource_usage: "low",
|
|
1924
|
+
},
|
|
1925
|
+
purpose: "Replace existing secret-management-access",
|
|
1926
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1927
|
+
side_effects: {
|
|
1928
|
+
modifies: ["secret-management-access"],
|
|
1929
|
+
},
|
|
1930
|
+
},
|
|
1931
|
+
},
|
|
1932
|
+
{
|
|
1933
|
+
toolName: "f5xc-api-blindfold-secret-policy-create",
|
|
1934
|
+
method: "POST",
|
|
1935
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/secret_policys",
|
|
1936
|
+
operation: "create",
|
|
1937
|
+
domain: "blindfold",
|
|
1938
|
+
resource: "secret-policy",
|
|
1939
|
+
summary: "Create Secret Policy.",
|
|
1940
|
+
description: "Create secret_policy creates a new object in the storage backend for metadata.namespace.",
|
|
1941
|
+
pathParameters: [
|
|
1942
|
+
{
|
|
1943
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
1944
|
+
in: "path",
|
|
1945
|
+
name: "metadata.namespace",
|
|
1946
|
+
required: true,
|
|
1947
|
+
schema: {
|
|
1948
|
+
type: "string",
|
|
1949
|
+
},
|
|
1950
|
+
"x-displayname": "Namespace",
|
|
1951
|
+
"x-ves-example": "Staging",
|
|
1952
|
+
},
|
|
1953
|
+
],
|
|
1954
|
+
queryParameters: [],
|
|
1955
|
+
requestBodySchema: {
|
|
1956
|
+
$ref: "#/components/schemas/secret_policyCreateRequest",
|
|
1957
|
+
},
|
|
1958
|
+
responseSchema: {
|
|
1959
|
+
$ref: "#/components/schemas/secret_policyCreateResponse",
|
|
1960
|
+
},
|
|
1961
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1962
|
+
operationId: "ves.io.schema.secret_policy.API.Create",
|
|
1963
|
+
tags: ["Security"],
|
|
1964
|
+
sourceFile: "domains/blindfold.json",
|
|
1965
|
+
displayName: null,
|
|
1966
|
+
dangerLevel: "medium",
|
|
1967
|
+
sideEffects: {
|
|
1968
|
+
creates: ["secret-policy"],
|
|
1969
|
+
},
|
|
1970
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1971
|
+
cliExamples: [
|
|
1972
|
+
{
|
|
1973
|
+
command: "f5xcctl secret_management secret-policy create -f {file}.yaml",
|
|
1974
|
+
description: "Create from YAML file",
|
|
1975
|
+
use_case: "file_based",
|
|
1976
|
+
},
|
|
1977
|
+
{
|
|
1978
|
+
command: "f5xcctl secret_management secret-policy create {name} --namespace {namespace}",
|
|
1979
|
+
description: "Create secret-policy",
|
|
1980
|
+
use_case: "basic_create",
|
|
1981
|
+
},
|
|
1982
|
+
],
|
|
1983
|
+
confirmationRequired: false,
|
|
1984
|
+
parameterExamples: {
|
|
1985
|
+
"metadata.namespace": "Staging",
|
|
1986
|
+
},
|
|
1987
|
+
validationRules: {},
|
|
1988
|
+
operationMetadata: {
|
|
1989
|
+
common_errors: [
|
|
1990
|
+
{
|
|
1991
|
+
code: 401,
|
|
1992
|
+
message: "Authentication required",
|
|
1993
|
+
solution: "Provide valid API credentials",
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
code: 403,
|
|
1997
|
+
message: "Permission denied",
|
|
1998
|
+
solution: "Check access permissions for this operation",
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
code: 404,
|
|
2002
|
+
message: "Resource not found",
|
|
2003
|
+
solution: "Verify resource name, namespace, and path",
|
|
2004
|
+
},
|
|
2005
|
+
{
|
|
2006
|
+
code: 409,
|
|
2007
|
+
message: "Resource already exists",
|
|
2008
|
+
solution: "Use different name or update existing resource",
|
|
2009
|
+
},
|
|
2010
|
+
{
|
|
2011
|
+
code: 429,
|
|
2012
|
+
message: "Rate limit exceeded",
|
|
2013
|
+
solution: "Wait before retrying the operation",
|
|
2014
|
+
},
|
|
2015
|
+
{
|
|
2016
|
+
code: 500,
|
|
2017
|
+
message: "Server error",
|
|
2018
|
+
solution: "Retry operation or contact support",
|
|
2019
|
+
},
|
|
2020
|
+
],
|
|
2021
|
+
conditions: {
|
|
2022
|
+
postconditions: ["Secret-policy resource created", "Resource assigned unique identifier"],
|
|
2023
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2024
|
+
},
|
|
2025
|
+
confirmation_required: false,
|
|
2026
|
+
danger_level: "medium",
|
|
2027
|
+
examples: [
|
|
2028
|
+
{
|
|
2029
|
+
command: "f5xcctl secret_management secret-policy create {name} --namespace {namespace}",
|
|
2030
|
+
description: "Create secret-policy",
|
|
2031
|
+
use_case: "basic_create",
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
command: "f5xcctl secret_management secret-policy create -f {file}.yaml",
|
|
2035
|
+
description: "Create from YAML file",
|
|
2036
|
+
use_case: "file_based",
|
|
2037
|
+
},
|
|
2038
|
+
],
|
|
2039
|
+
field_docs: {},
|
|
2040
|
+
optional_fields: [],
|
|
2041
|
+
performance_impact: {
|
|
2042
|
+
latency: "low",
|
|
2043
|
+
resource_usage: "low",
|
|
2044
|
+
},
|
|
2045
|
+
purpose: "Create new secret-policy",
|
|
2046
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2047
|
+
side_effects: {
|
|
2048
|
+
creates: ["secret-policy"],
|
|
2049
|
+
},
|
|
2050
|
+
},
|
|
2051
|
+
},
|
|
2052
|
+
{
|
|
2053
|
+
toolName: "f5xc-api-blindfold-secret-policy-delete",
|
|
2054
|
+
method: "DELETE",
|
|
2055
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policys/{name}",
|
|
2056
|
+
operation: "delete",
|
|
2057
|
+
domain: "blindfold",
|
|
2058
|
+
resource: "secret-policy",
|
|
2059
|
+
summary: "DELETE Secret Policy.",
|
|
2060
|
+
description: "DELETE the specified secret_policy.",
|
|
2061
|
+
pathParameters: [
|
|
2062
|
+
{
|
|
2063
|
+
description: "Name\nName of the configuration object.",
|
|
2064
|
+
in: "path",
|
|
2065
|
+
name: "name",
|
|
2066
|
+
required: true,
|
|
2067
|
+
schema: {
|
|
2068
|
+
type: "string",
|
|
2069
|
+
},
|
|
2070
|
+
"x-displayname": "Name",
|
|
2071
|
+
"x-ves-example": "Name",
|
|
2072
|
+
},
|
|
2073
|
+
{
|
|
2074
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
2075
|
+
in: "path",
|
|
2076
|
+
name: "namespace",
|
|
2077
|
+
required: true,
|
|
2078
|
+
schema: {
|
|
2079
|
+
type: "string",
|
|
2080
|
+
},
|
|
2081
|
+
"x-displayname": "Namespace",
|
|
2082
|
+
"x-ves-example": "Ns1",
|
|
2083
|
+
},
|
|
2084
|
+
],
|
|
2085
|
+
queryParameters: [],
|
|
2086
|
+
requestBodySchema: {
|
|
2087
|
+
$ref: "#/components/schemas/secret_policyDeleteRequest",
|
|
2088
|
+
},
|
|
2089
|
+
responseSchema: {},
|
|
2090
|
+
requiredParams: ["body", "name", "namespace"],
|
|
2091
|
+
operationId: "ves.io.schema.secret_policy.API.Delete",
|
|
2092
|
+
tags: ["Security"],
|
|
2093
|
+
sourceFile: "domains/blindfold.json",
|
|
2094
|
+
displayName: null,
|
|
2095
|
+
dangerLevel: "high",
|
|
2096
|
+
sideEffects: {
|
|
2097
|
+
deletes: ["secret-policy", "contained_resources"],
|
|
2098
|
+
},
|
|
2099
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2100
|
+
cliExamples: [
|
|
2101
|
+
{
|
|
2102
|
+
command: "f5xcctl secret_management secret-policy delete {name} --namespace {namespace}",
|
|
2103
|
+
description: "Delete secret-policy",
|
|
2104
|
+
use_case: "delete",
|
|
2105
|
+
},
|
|
2106
|
+
],
|
|
2107
|
+
confirmationRequired: true,
|
|
2108
|
+
parameterExamples: {
|
|
2109
|
+
name: "Name",
|
|
2110
|
+
namespace: "Ns1",
|
|
2111
|
+
},
|
|
2112
|
+
validationRules: {},
|
|
2113
|
+
operationMetadata: {
|
|
2114
|
+
common_errors: [
|
|
2115
|
+
{
|
|
2116
|
+
code: 401,
|
|
2117
|
+
message: "Authentication required",
|
|
2118
|
+
solution: "Provide valid API credentials",
|
|
2119
|
+
},
|
|
2120
|
+
{
|
|
2121
|
+
code: 403,
|
|
2122
|
+
message: "Permission denied",
|
|
2123
|
+
solution: "Check access permissions for this operation",
|
|
2124
|
+
},
|
|
2125
|
+
{
|
|
2126
|
+
code: 404,
|
|
2127
|
+
message: "Resource not found",
|
|
2128
|
+
solution: "Verify resource name, namespace, and path",
|
|
2129
|
+
},
|
|
2130
|
+
{
|
|
2131
|
+
code: 409,
|
|
2132
|
+
message: "Resource already exists",
|
|
2133
|
+
solution: "Use different name or update existing resource",
|
|
2134
|
+
},
|
|
2135
|
+
{
|
|
2136
|
+
code: 429,
|
|
2137
|
+
message: "Rate limit exceeded",
|
|
2138
|
+
solution: "Wait before retrying the operation",
|
|
2139
|
+
},
|
|
2140
|
+
{
|
|
2141
|
+
code: 500,
|
|
2142
|
+
message: "Server error",
|
|
2143
|
+
solution: "Retry operation or contact support",
|
|
2144
|
+
},
|
|
2145
|
+
],
|
|
2146
|
+
conditions: {
|
|
2147
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2148
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2149
|
+
},
|
|
2150
|
+
confirmation_required: true,
|
|
2151
|
+
danger_level: "high",
|
|
2152
|
+
examples: [
|
|
2153
|
+
{
|
|
2154
|
+
command: "f5xcctl secret_management secret-policy delete {name} --namespace {namespace}",
|
|
2155
|
+
description: "Delete secret-policy",
|
|
2156
|
+
use_case: "delete",
|
|
2157
|
+
},
|
|
2158
|
+
],
|
|
2159
|
+
field_docs: {},
|
|
2160
|
+
optional_fields: [],
|
|
2161
|
+
performance_impact: {
|
|
2162
|
+
latency: "high",
|
|
2163
|
+
resource_usage: "moderate",
|
|
2164
|
+
},
|
|
2165
|
+
purpose: "Delete secret-policy",
|
|
2166
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2167
|
+
side_effects: {
|
|
2168
|
+
deletes: ["secret-policy", "contained_resources"],
|
|
2169
|
+
},
|
|
2170
|
+
},
|
|
2171
|
+
},
|
|
2172
|
+
{
|
|
2173
|
+
toolName: "f5xc-api-blindfold-secret-policy-get",
|
|
2174
|
+
method: "GET",
|
|
2175
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policys/{name}",
|
|
2176
|
+
operation: "get",
|
|
2177
|
+
domain: "blindfold",
|
|
2178
|
+
resource: "secret-policy",
|
|
2179
|
+
summary: "GET Secret Policy.",
|
|
2180
|
+
description: "GET secret_policy reads a given object from storage backend for metadata.namespace.",
|
|
2181
|
+
pathParameters: [
|
|
2182
|
+
{
|
|
2183
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2184
|
+
in: "path",
|
|
2185
|
+
name: "name",
|
|
2186
|
+
required: true,
|
|
2187
|
+
schema: {
|
|
2188
|
+
type: "string",
|
|
2189
|
+
},
|
|
2190
|
+
"x-displayname": "Name",
|
|
2191
|
+
"x-ves-example": "Name",
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2195
|
+
in: "path",
|
|
2196
|
+
name: "namespace",
|
|
2197
|
+
required: true,
|
|
2198
|
+
schema: {
|
|
2199
|
+
type: "string",
|
|
2200
|
+
},
|
|
2201
|
+
"x-displayname": "Namespace",
|
|
2202
|
+
"x-ves-example": "Ns1",
|
|
2203
|
+
},
|
|
2204
|
+
],
|
|
2205
|
+
queryParameters: [
|
|
2206
|
+
{
|
|
2207
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
2208
|
+
in: "query",
|
|
2209
|
+
name: "response_format",
|
|
2210
|
+
required: false,
|
|
2211
|
+
schema: {
|
|
2212
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2213
|
+
enum: [
|
|
2214
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2215
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2216
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2217
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2218
|
+
"GET_RSP_FORMAT_READ",
|
|
2219
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2220
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2221
|
+
],
|
|
2222
|
+
type: "string",
|
|
2223
|
+
},
|
|
2224
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2225
|
+
},
|
|
2226
|
+
],
|
|
2227
|
+
requestBodySchema: null,
|
|
2228
|
+
responseSchema: {
|
|
2229
|
+
$ref: "#/components/schemas/secret_policyGetResponse",
|
|
2230
|
+
},
|
|
2231
|
+
requiredParams: ["name", "namespace"],
|
|
2232
|
+
operationId: "ves.io.schema.secret_policy.API.Get",
|
|
2233
|
+
tags: ["Security"],
|
|
2234
|
+
sourceFile: "domains/blindfold.json",
|
|
2235
|
+
displayName: null,
|
|
2236
|
+
dangerLevel: "low",
|
|
2237
|
+
sideEffects: null,
|
|
2238
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2239
|
+
cliExamples: [
|
|
2240
|
+
{
|
|
2241
|
+
command: "f5xcctl secret_management secret-policy get {name} --namespace {namespace}",
|
|
2242
|
+
description: "Get specific secret-policy",
|
|
2243
|
+
use_case: "get_specific",
|
|
2244
|
+
},
|
|
2245
|
+
],
|
|
2246
|
+
confirmationRequired: false,
|
|
2247
|
+
parameterExamples: {
|
|
2248
|
+
name: "Name",
|
|
2249
|
+
namespace: "Ns1",
|
|
2250
|
+
},
|
|
2251
|
+
validationRules: {},
|
|
2252
|
+
operationMetadata: {
|
|
2253
|
+
common_errors: [
|
|
2254
|
+
{
|
|
2255
|
+
code: 401,
|
|
2256
|
+
message: "Authentication required",
|
|
2257
|
+
solution: "Provide valid API credentials",
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
code: 403,
|
|
2261
|
+
message: "Permission denied",
|
|
2262
|
+
solution: "Check access permissions for this operation",
|
|
2263
|
+
},
|
|
2264
|
+
{
|
|
2265
|
+
code: 404,
|
|
2266
|
+
message: "Resource not found",
|
|
2267
|
+
solution: "Verify resource name, namespace, and path",
|
|
2268
|
+
},
|
|
2269
|
+
{
|
|
2270
|
+
code: 409,
|
|
2271
|
+
message: "Resource already exists",
|
|
2272
|
+
solution: "Use different name or update existing resource",
|
|
2273
|
+
},
|
|
2274
|
+
{
|
|
2275
|
+
code: 429,
|
|
2276
|
+
message: "Rate limit exceeded",
|
|
2277
|
+
solution: "Wait before retrying the operation",
|
|
2278
|
+
},
|
|
2279
|
+
{
|
|
2280
|
+
code: 500,
|
|
2281
|
+
message: "Server error",
|
|
2282
|
+
solution: "Retry operation or contact support",
|
|
2283
|
+
},
|
|
2284
|
+
],
|
|
2285
|
+
conditions: {
|
|
2286
|
+
postconditions: [],
|
|
2287
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2288
|
+
},
|
|
2289
|
+
confirmation_required: false,
|
|
2290
|
+
danger_level: "low",
|
|
2291
|
+
examples: [
|
|
2292
|
+
{
|
|
2293
|
+
command: "f5xcctl secret_management secret-policy get {name} --namespace {namespace}",
|
|
2294
|
+
description: "Get specific secret-policy",
|
|
2295
|
+
use_case: "get_specific",
|
|
2296
|
+
},
|
|
2297
|
+
],
|
|
2298
|
+
field_docs: {},
|
|
2299
|
+
optional_fields: [],
|
|
2300
|
+
performance_impact: {
|
|
2301
|
+
latency: "low",
|
|
2302
|
+
resource_usage: "low",
|
|
2303
|
+
},
|
|
2304
|
+
purpose: "Retrieve specific secret-policy",
|
|
2305
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2306
|
+
side_effects: {},
|
|
2307
|
+
},
|
|
2308
|
+
},
|
|
2309
|
+
{
|
|
2310
|
+
toolName: "f5xc-api-blindfold-secret-policy-list",
|
|
2311
|
+
method: "GET",
|
|
2312
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policys",
|
|
2313
|
+
operation: "list",
|
|
2314
|
+
domain: "blindfold",
|
|
2315
|
+
resource: "secret-policy",
|
|
2316
|
+
summary: "List Secret Policy.",
|
|
2317
|
+
description: "List the set of secret_policy in a namespace.",
|
|
2318
|
+
pathParameters: [
|
|
2319
|
+
{
|
|
2320
|
+
description: "Namespace\nNamespace to scope the listing of secret_policy.",
|
|
2321
|
+
in: "path",
|
|
2322
|
+
name: "namespace",
|
|
2323
|
+
required: true,
|
|
2324
|
+
schema: {
|
|
2325
|
+
type: "string",
|
|
2326
|
+
},
|
|
2327
|
+
"x-displayname": "Namespace",
|
|
2328
|
+
"x-ves-example": "Ns1",
|
|
2329
|
+
},
|
|
2330
|
+
],
|
|
2331
|
+
queryParameters: [
|
|
2332
|
+
{
|
|
2333
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2334
|
+
in: "query",
|
|
2335
|
+
name: "label_filter",
|
|
2336
|
+
required: false,
|
|
2337
|
+
schema: {
|
|
2338
|
+
type: "string",
|
|
2339
|
+
},
|
|
2340
|
+
"x-displayname": "Label Filter.",
|
|
2341
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2342
|
+
},
|
|
2343
|
+
{
|
|
2344
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2345
|
+
in: "query",
|
|
2346
|
+
name: "report_fields",
|
|
2347
|
+
required: false,
|
|
2348
|
+
schema: {
|
|
2349
|
+
items: {
|
|
2350
|
+
type: "string",
|
|
2351
|
+
},
|
|
2352
|
+
type: "array",
|
|
2353
|
+
},
|
|
2354
|
+
"x-displayname": "Report Fields.",
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2358
|
+
in: "query",
|
|
2359
|
+
name: "report_status_fields",
|
|
2360
|
+
required: false,
|
|
2361
|
+
schema: {
|
|
2362
|
+
items: {
|
|
2363
|
+
type: "string",
|
|
2364
|
+
},
|
|
2365
|
+
type: "array",
|
|
2366
|
+
},
|
|
2367
|
+
"x-displayname": "Report Status Fields.",
|
|
2368
|
+
},
|
|
2369
|
+
],
|
|
2370
|
+
requestBodySchema: null,
|
|
2371
|
+
responseSchema: {
|
|
2372
|
+
$ref: "#/components/schemas/secret_policyListResponse",
|
|
2373
|
+
},
|
|
2374
|
+
requiredParams: ["namespace"],
|
|
2375
|
+
operationId: "ves.io.schema.secret_policy.API.List",
|
|
2376
|
+
tags: ["Security"],
|
|
2377
|
+
sourceFile: "domains/blindfold.json",
|
|
2378
|
+
displayName: null,
|
|
2379
|
+
dangerLevel: "low",
|
|
2380
|
+
sideEffects: null,
|
|
2381
|
+
requiredFields: ["path.namespace"],
|
|
2382
|
+
cliExamples: [
|
|
2383
|
+
{
|
|
2384
|
+
command: "f5xcctl secret_management secret-policy list --namespace {namespace}",
|
|
2385
|
+
description: "List all secret-policys",
|
|
2386
|
+
use_case: "list_all",
|
|
2387
|
+
},
|
|
2388
|
+
],
|
|
2389
|
+
confirmationRequired: false,
|
|
2390
|
+
parameterExamples: {
|
|
2391
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2392
|
+
namespace: "Ns1",
|
|
2393
|
+
},
|
|
2394
|
+
validationRules: {},
|
|
2395
|
+
operationMetadata: {
|
|
2396
|
+
common_errors: [
|
|
2397
|
+
{
|
|
2398
|
+
code: 401,
|
|
2399
|
+
message: "Authentication required",
|
|
2400
|
+
solution: "Provide valid API credentials",
|
|
2401
|
+
},
|
|
2402
|
+
{
|
|
2403
|
+
code: 403,
|
|
2404
|
+
message: "Permission denied",
|
|
2405
|
+
solution: "Check access permissions for this operation",
|
|
2406
|
+
},
|
|
2407
|
+
{
|
|
2408
|
+
code: 404,
|
|
2409
|
+
message: "Resource not found",
|
|
2410
|
+
solution: "Verify resource name, namespace, and path",
|
|
2411
|
+
},
|
|
2412
|
+
{
|
|
2413
|
+
code: 409,
|
|
2414
|
+
message: "Resource already exists",
|
|
2415
|
+
solution: "Use different name or update existing resource",
|
|
2416
|
+
},
|
|
2417
|
+
{
|
|
2418
|
+
code: 429,
|
|
2419
|
+
message: "Rate limit exceeded",
|
|
2420
|
+
solution: "Wait before retrying the operation",
|
|
2421
|
+
},
|
|
2422
|
+
{
|
|
2423
|
+
code: 500,
|
|
2424
|
+
message: "Server error",
|
|
2425
|
+
solution: "Retry operation or contact support",
|
|
2426
|
+
},
|
|
2427
|
+
],
|
|
2428
|
+
conditions: {
|
|
2429
|
+
postconditions: [],
|
|
2430
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2431
|
+
},
|
|
2432
|
+
confirmation_required: false,
|
|
2433
|
+
danger_level: "low",
|
|
2434
|
+
examples: [
|
|
2435
|
+
{
|
|
2436
|
+
command: "f5xcctl secret_management secret-policy list --namespace {namespace}",
|
|
2437
|
+
description: "List all secret-policys",
|
|
2438
|
+
use_case: "list_all",
|
|
2439
|
+
},
|
|
2440
|
+
],
|
|
2441
|
+
field_docs: {},
|
|
2442
|
+
optional_fields: [],
|
|
2443
|
+
performance_impact: {
|
|
2444
|
+
latency: "moderate",
|
|
2445
|
+
resource_usage: "moderate",
|
|
2446
|
+
},
|
|
2447
|
+
purpose: "List all secret-policys",
|
|
2448
|
+
required_fields: ["path.namespace"],
|
|
2449
|
+
side_effects: {},
|
|
2450
|
+
},
|
|
2451
|
+
},
|
|
2452
|
+
{
|
|
2453
|
+
toolName: "f5xc-api-blindfold-secret-policy-rule-create",
|
|
2454
|
+
method: "POST",
|
|
2455
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/secret_policy_rules",
|
|
2456
|
+
operation: "create",
|
|
2457
|
+
domain: "blindfold",
|
|
2458
|
+
resource: "secret-policy-rule",
|
|
2459
|
+
summary: "Create Secret Policy Rule.",
|
|
2460
|
+
description: "Create secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
2461
|
+
pathParameters: [
|
|
2462
|
+
{
|
|
2463
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
2464
|
+
in: "path",
|
|
2465
|
+
name: "metadata.namespace",
|
|
2466
|
+
required: true,
|
|
2467
|
+
schema: {
|
|
2468
|
+
type: "string",
|
|
2469
|
+
},
|
|
2470
|
+
"x-displayname": "Namespace",
|
|
2471
|
+
"x-ves-example": "Staging",
|
|
2472
|
+
},
|
|
2473
|
+
],
|
|
2474
|
+
queryParameters: [],
|
|
2475
|
+
requestBodySchema: {
|
|
2476
|
+
$ref: "#/components/schemas/secret_policy_ruleCreateRequest",
|
|
2477
|
+
},
|
|
2478
|
+
responseSchema: {
|
|
2479
|
+
$ref: "#/components/schemas/secret_policy_ruleCreateResponse",
|
|
2480
|
+
},
|
|
2481
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
2482
|
+
operationId: "ves.io.schema.secret_policy_rule.API.Create",
|
|
2483
|
+
tags: ["Security"],
|
|
2484
|
+
sourceFile: "domains/blindfold.json",
|
|
2485
|
+
displayName: null,
|
|
2486
|
+
dangerLevel: "medium",
|
|
2487
|
+
sideEffects: {
|
|
2488
|
+
creates: ["secret-policy-rule"],
|
|
2489
|
+
},
|
|
2490
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2491
|
+
cliExamples: [
|
|
2492
|
+
{
|
|
2493
|
+
command: "f5xcctl secret_management secret-policy-rule create -f {file}.yaml",
|
|
2494
|
+
description: "Create from YAML file",
|
|
2495
|
+
use_case: "file_based",
|
|
2496
|
+
},
|
|
2497
|
+
{
|
|
2498
|
+
command: "f5xcctl secret_management secret-policy-rule create {name} --namespace {namespace}",
|
|
2499
|
+
description: "Create secret-policy-rule",
|
|
2500
|
+
use_case: "basic_create",
|
|
2501
|
+
},
|
|
2502
|
+
],
|
|
2503
|
+
confirmationRequired: false,
|
|
2504
|
+
parameterExamples: {
|
|
2505
|
+
"metadata.namespace": "Staging",
|
|
2506
|
+
},
|
|
2507
|
+
validationRules: {},
|
|
2508
|
+
operationMetadata: {
|
|
2509
|
+
common_errors: [
|
|
2510
|
+
{
|
|
2511
|
+
code: 401,
|
|
2512
|
+
message: "Authentication required",
|
|
2513
|
+
solution: "Provide valid API credentials",
|
|
2514
|
+
},
|
|
2515
|
+
{
|
|
2516
|
+
code: 403,
|
|
2517
|
+
message: "Permission denied",
|
|
2518
|
+
solution: "Check access permissions for this operation",
|
|
2519
|
+
},
|
|
2520
|
+
{
|
|
2521
|
+
code: 404,
|
|
2522
|
+
message: "Resource not found",
|
|
2523
|
+
solution: "Verify resource name, namespace, and path",
|
|
2524
|
+
},
|
|
2525
|
+
{
|
|
2526
|
+
code: 409,
|
|
2527
|
+
message: "Resource already exists",
|
|
2528
|
+
solution: "Use different name or update existing resource",
|
|
2529
|
+
},
|
|
2530
|
+
{
|
|
2531
|
+
code: 429,
|
|
2532
|
+
message: "Rate limit exceeded",
|
|
2533
|
+
solution: "Wait before retrying the operation",
|
|
2534
|
+
},
|
|
2535
|
+
{
|
|
2536
|
+
code: 500,
|
|
2537
|
+
message: "Server error",
|
|
2538
|
+
solution: "Retry operation or contact support",
|
|
2539
|
+
},
|
|
2540
|
+
],
|
|
2541
|
+
conditions: {
|
|
2542
|
+
postconditions: [
|
|
2543
|
+
"Secret-policy-rule resource created",
|
|
2544
|
+
"Resource assigned unique identifier",
|
|
2545
|
+
],
|
|
2546
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2547
|
+
},
|
|
2548
|
+
confirmation_required: false,
|
|
2549
|
+
danger_level: "medium",
|
|
2550
|
+
examples: [
|
|
2551
|
+
{
|
|
2552
|
+
command: "f5xcctl secret_management secret-policy-rule create {name} --namespace {namespace}",
|
|
2553
|
+
description: "Create secret-policy-rule",
|
|
2554
|
+
use_case: "basic_create",
|
|
2555
|
+
},
|
|
2556
|
+
{
|
|
2557
|
+
command: "f5xcctl secret_management secret-policy-rule create -f {file}.yaml",
|
|
2558
|
+
description: "Create from YAML file",
|
|
2559
|
+
use_case: "file_based",
|
|
2560
|
+
},
|
|
2561
|
+
],
|
|
2562
|
+
field_docs: {},
|
|
2563
|
+
optional_fields: [],
|
|
2564
|
+
performance_impact: {
|
|
2565
|
+
latency: "low",
|
|
2566
|
+
resource_usage: "low",
|
|
2567
|
+
},
|
|
2568
|
+
purpose: "Create new secret-policy-rule",
|
|
2569
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2570
|
+
side_effects: {
|
|
2571
|
+
creates: ["secret-policy-rule"],
|
|
2572
|
+
},
|
|
2573
|
+
},
|
|
2574
|
+
},
|
|
2575
|
+
{
|
|
2576
|
+
toolName: "f5xc-api-blindfold-secret-policy-rule-delete",
|
|
2577
|
+
method: "DELETE",
|
|
2578
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy_rules/{name}",
|
|
2579
|
+
operation: "delete",
|
|
2580
|
+
domain: "blindfold",
|
|
2581
|
+
resource: "secret-policy-rule",
|
|
2582
|
+
summary: "DELETE Secret Policy Rule.",
|
|
2583
|
+
description: "DELETE the specified secret_policy_rule.",
|
|
2584
|
+
pathParameters: [
|
|
2585
|
+
{
|
|
2586
|
+
description: "Name\nName of the configuration object.",
|
|
2587
|
+
in: "path",
|
|
2588
|
+
name: "name",
|
|
2589
|
+
required: true,
|
|
2590
|
+
schema: {
|
|
2591
|
+
type: "string",
|
|
2592
|
+
},
|
|
2593
|
+
"x-displayname": "Name",
|
|
2594
|
+
"x-ves-example": "Name",
|
|
2595
|
+
},
|
|
2596
|
+
{
|
|
2597
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
2598
|
+
in: "path",
|
|
2599
|
+
name: "namespace",
|
|
2600
|
+
required: true,
|
|
2601
|
+
schema: {
|
|
2602
|
+
type: "string",
|
|
2603
|
+
},
|
|
2604
|
+
"x-displayname": "Namespace",
|
|
2605
|
+
"x-ves-example": "Ns1",
|
|
2606
|
+
},
|
|
2607
|
+
],
|
|
2608
|
+
queryParameters: [],
|
|
2609
|
+
requestBodySchema: {
|
|
2610
|
+
$ref: "#/components/schemas/secret_policy_ruleDeleteRequest",
|
|
2611
|
+
},
|
|
2612
|
+
responseSchema: {},
|
|
2613
|
+
requiredParams: ["body", "name", "namespace"],
|
|
2614
|
+
operationId: "ves.io.schema.secret_policy_rule.API.Delete",
|
|
2615
|
+
tags: ["Security"],
|
|
2616
|
+
sourceFile: "domains/blindfold.json",
|
|
2617
|
+
displayName: null,
|
|
2618
|
+
dangerLevel: "high",
|
|
2619
|
+
sideEffects: {
|
|
2620
|
+
deletes: ["secret-policy-rule", "contained_resources"],
|
|
2621
|
+
},
|
|
2622
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2623
|
+
cliExamples: [
|
|
2624
|
+
{
|
|
2625
|
+
command: "f5xcctl secret_management secret-policy-rule delete {name} --namespace {namespace}",
|
|
2626
|
+
description: "Delete secret-policy-rule",
|
|
2627
|
+
use_case: "delete",
|
|
2628
|
+
},
|
|
2629
|
+
],
|
|
2630
|
+
confirmationRequired: true,
|
|
2631
|
+
parameterExamples: {
|
|
2632
|
+
name: "Name",
|
|
2633
|
+
namespace: "Ns1",
|
|
2634
|
+
},
|
|
2635
|
+
validationRules: {},
|
|
2636
|
+
operationMetadata: {
|
|
2637
|
+
common_errors: [
|
|
2638
|
+
{
|
|
2639
|
+
code: 401,
|
|
2640
|
+
message: "Authentication required",
|
|
2641
|
+
solution: "Provide valid API credentials",
|
|
2642
|
+
},
|
|
2643
|
+
{
|
|
2644
|
+
code: 403,
|
|
2645
|
+
message: "Permission denied",
|
|
2646
|
+
solution: "Check access permissions for this operation",
|
|
2647
|
+
},
|
|
2648
|
+
{
|
|
2649
|
+
code: 404,
|
|
2650
|
+
message: "Resource not found",
|
|
2651
|
+
solution: "Verify resource name, namespace, and path",
|
|
2652
|
+
},
|
|
2653
|
+
{
|
|
2654
|
+
code: 409,
|
|
2655
|
+
message: "Resource already exists",
|
|
2656
|
+
solution: "Use different name or update existing resource",
|
|
2657
|
+
},
|
|
2658
|
+
{
|
|
2659
|
+
code: 429,
|
|
2660
|
+
message: "Rate limit exceeded",
|
|
2661
|
+
solution: "Wait before retrying the operation",
|
|
2662
|
+
},
|
|
2663
|
+
{
|
|
2664
|
+
code: 500,
|
|
2665
|
+
message: "Server error",
|
|
2666
|
+
solution: "Retry operation or contact support",
|
|
2667
|
+
},
|
|
2668
|
+
],
|
|
2669
|
+
conditions: {
|
|
2670
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
2671
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2672
|
+
},
|
|
2673
|
+
confirmation_required: true,
|
|
2674
|
+
danger_level: "high",
|
|
2675
|
+
examples: [
|
|
2676
|
+
{
|
|
2677
|
+
command: "f5xcctl secret_management secret-policy-rule delete {name} --namespace {namespace}",
|
|
2678
|
+
description: "Delete secret-policy-rule",
|
|
2679
|
+
use_case: "delete",
|
|
2680
|
+
},
|
|
2681
|
+
],
|
|
2682
|
+
field_docs: {},
|
|
2683
|
+
optional_fields: [],
|
|
2684
|
+
performance_impact: {
|
|
2685
|
+
latency: "high",
|
|
2686
|
+
resource_usage: "moderate",
|
|
2687
|
+
},
|
|
2688
|
+
purpose: "Delete secret-policy-rule",
|
|
2689
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2690
|
+
side_effects: {
|
|
2691
|
+
deletes: ["secret-policy-rule", "contained_resources"],
|
|
2692
|
+
},
|
|
2693
|
+
},
|
|
2694
|
+
},
|
|
2695
|
+
{
|
|
2696
|
+
toolName: "f5xc-api-blindfold-secret-policy-rule-get",
|
|
2697
|
+
method: "GET",
|
|
2698
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy_rules/{name}",
|
|
2699
|
+
operation: "get",
|
|
2700
|
+
domain: "blindfold",
|
|
2701
|
+
resource: "secret-policy-rule",
|
|
2702
|
+
summary: "GET Secret Policy Rule.",
|
|
2703
|
+
description: "GET secret_policy_rule reads a given object from storage backend for metadata.namespace.",
|
|
2704
|
+
pathParameters: [
|
|
2705
|
+
{
|
|
2706
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2707
|
+
in: "path",
|
|
2708
|
+
name: "name",
|
|
2709
|
+
required: true,
|
|
2710
|
+
schema: {
|
|
2711
|
+
type: "string",
|
|
2712
|
+
},
|
|
2713
|
+
"x-displayname": "Name",
|
|
2714
|
+
"x-ves-example": "Name",
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2718
|
+
in: "path",
|
|
2719
|
+
name: "namespace",
|
|
2720
|
+
required: true,
|
|
2721
|
+
schema: {
|
|
2722
|
+
type: "string",
|
|
2723
|
+
},
|
|
2724
|
+
"x-displayname": "Namespace",
|
|
2725
|
+
"x-ves-example": "Ns1",
|
|
2726
|
+
},
|
|
2727
|
+
],
|
|
2728
|
+
queryParameters: [
|
|
2729
|
+
{
|
|
2730
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
2731
|
+
in: "query",
|
|
2732
|
+
name: "response_format",
|
|
2733
|
+
required: false,
|
|
2734
|
+
schema: {
|
|
2735
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2736
|
+
enum: [
|
|
2737
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2738
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2739
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2740
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2741
|
+
"GET_RSP_FORMAT_READ",
|
|
2742
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2743
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2744
|
+
],
|
|
2745
|
+
type: "string",
|
|
2746
|
+
},
|
|
2747
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2748
|
+
},
|
|
2749
|
+
],
|
|
2750
|
+
requestBodySchema: null,
|
|
2751
|
+
responseSchema: {
|
|
2752
|
+
$ref: "#/components/schemas/secret_policy_ruleGetResponse",
|
|
2753
|
+
},
|
|
2754
|
+
requiredParams: ["name", "namespace"],
|
|
2755
|
+
operationId: "ves.io.schema.secret_policy_rule.API.Get",
|
|
2756
|
+
tags: ["Security"],
|
|
2757
|
+
sourceFile: "domains/blindfold.json",
|
|
2758
|
+
displayName: null,
|
|
2759
|
+
dangerLevel: "low",
|
|
2760
|
+
sideEffects: null,
|
|
2761
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2762
|
+
cliExamples: [
|
|
2763
|
+
{
|
|
2764
|
+
command: "f5xcctl secret_management secret-policy-rule get {name} --namespace {namespace}",
|
|
2765
|
+
description: "Get specific secret-policy-rule",
|
|
2766
|
+
use_case: "get_specific",
|
|
2767
|
+
},
|
|
2768
|
+
],
|
|
2769
|
+
confirmationRequired: false,
|
|
2770
|
+
parameterExamples: {
|
|
2771
|
+
name: "Name",
|
|
2772
|
+
namespace: "Ns1",
|
|
2773
|
+
},
|
|
2774
|
+
validationRules: {},
|
|
2775
|
+
operationMetadata: {
|
|
2776
|
+
common_errors: [
|
|
2777
|
+
{
|
|
2778
|
+
code: 401,
|
|
2779
|
+
message: "Authentication required",
|
|
2780
|
+
solution: "Provide valid API credentials",
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
code: 403,
|
|
2784
|
+
message: "Permission denied",
|
|
2785
|
+
solution: "Check access permissions for this operation",
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
code: 404,
|
|
2789
|
+
message: "Resource not found",
|
|
2790
|
+
solution: "Verify resource name, namespace, and path",
|
|
2791
|
+
},
|
|
2792
|
+
{
|
|
2793
|
+
code: 409,
|
|
2794
|
+
message: "Resource already exists",
|
|
2795
|
+
solution: "Use different name or update existing resource",
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
code: 429,
|
|
2799
|
+
message: "Rate limit exceeded",
|
|
2800
|
+
solution: "Wait before retrying the operation",
|
|
2801
|
+
},
|
|
2802
|
+
{
|
|
2803
|
+
code: 500,
|
|
2804
|
+
message: "Server error",
|
|
2805
|
+
solution: "Retry operation or contact support",
|
|
2806
|
+
},
|
|
2807
|
+
],
|
|
2808
|
+
conditions: {
|
|
2809
|
+
postconditions: [],
|
|
2810
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2811
|
+
},
|
|
2812
|
+
confirmation_required: false,
|
|
2813
|
+
danger_level: "low",
|
|
2814
|
+
examples: [
|
|
2815
|
+
{
|
|
2816
|
+
command: "f5xcctl secret_management secret-policy-rule get {name} --namespace {namespace}",
|
|
2817
|
+
description: "Get specific secret-policy-rule",
|
|
2818
|
+
use_case: "get_specific",
|
|
2819
|
+
},
|
|
2820
|
+
],
|
|
2821
|
+
field_docs: {},
|
|
2822
|
+
optional_fields: [],
|
|
2823
|
+
performance_impact: {
|
|
2824
|
+
latency: "low",
|
|
2825
|
+
resource_usage: "low",
|
|
2826
|
+
},
|
|
2827
|
+
purpose: "Retrieve specific secret-policy-rule",
|
|
2828
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2829
|
+
side_effects: {},
|
|
2830
|
+
},
|
|
2831
|
+
},
|
|
2832
|
+
{
|
|
2833
|
+
toolName: "f5xc-api-blindfold-secret-policy-rule-list",
|
|
2834
|
+
method: "GET",
|
|
2835
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy_rules",
|
|
2836
|
+
operation: "list",
|
|
2837
|
+
domain: "blindfold",
|
|
2838
|
+
resource: "secret-policy-rule",
|
|
2839
|
+
summary: "List Secret Policy Rule.",
|
|
2840
|
+
description: "List the set of secret_policy_rule in a namespace.",
|
|
2841
|
+
pathParameters: [
|
|
2842
|
+
{
|
|
2843
|
+
description: "Namespace\nNamespace to scope the listing of secret_policy_rule.",
|
|
2844
|
+
in: "path",
|
|
2845
|
+
name: "namespace",
|
|
2846
|
+
required: true,
|
|
2847
|
+
schema: {
|
|
2848
|
+
type: "string",
|
|
2849
|
+
},
|
|
2850
|
+
"x-displayname": "Namespace",
|
|
2851
|
+
"x-ves-example": "Ns1",
|
|
2852
|
+
},
|
|
2853
|
+
],
|
|
2854
|
+
queryParameters: [
|
|
2855
|
+
{
|
|
2856
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2857
|
+
in: "query",
|
|
2858
|
+
name: "label_filter",
|
|
2859
|
+
required: false,
|
|
2860
|
+
schema: {
|
|
2861
|
+
type: "string",
|
|
2862
|
+
},
|
|
2863
|
+
"x-displayname": "Label Filter.",
|
|
2864
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2865
|
+
},
|
|
2866
|
+
{
|
|
2867
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2868
|
+
in: "query",
|
|
2869
|
+
name: "report_fields",
|
|
2870
|
+
required: false,
|
|
2871
|
+
schema: {
|
|
2872
|
+
items: {
|
|
2873
|
+
type: "string",
|
|
2874
|
+
},
|
|
2875
|
+
type: "array",
|
|
2876
|
+
},
|
|
2877
|
+
"x-displayname": "Report Fields.",
|
|
2878
|
+
},
|
|
2879
|
+
{
|
|
2880
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2881
|
+
in: "query",
|
|
2882
|
+
name: "report_status_fields",
|
|
2883
|
+
required: false,
|
|
2884
|
+
schema: {
|
|
2885
|
+
items: {
|
|
2886
|
+
type: "string",
|
|
2887
|
+
},
|
|
2888
|
+
type: "array",
|
|
2889
|
+
},
|
|
2890
|
+
"x-displayname": "Report Status Fields.",
|
|
2891
|
+
},
|
|
2892
|
+
],
|
|
2893
|
+
requestBodySchema: null,
|
|
2894
|
+
responseSchema: {
|
|
2895
|
+
$ref: "#/components/schemas/secret_policy_ruleListResponse",
|
|
2896
|
+
},
|
|
2897
|
+
requiredParams: ["namespace"],
|
|
2898
|
+
operationId: "ves.io.schema.secret_policy_rule.API.List",
|
|
2899
|
+
tags: ["Security"],
|
|
2900
|
+
sourceFile: "domains/blindfold.json",
|
|
2901
|
+
displayName: null,
|
|
2902
|
+
dangerLevel: "low",
|
|
2903
|
+
sideEffects: null,
|
|
2904
|
+
requiredFields: ["path.namespace"],
|
|
2905
|
+
cliExamples: [
|
|
2906
|
+
{
|
|
2907
|
+
command: "f5xcctl secret_management secret-policy-rule list --namespace {namespace}",
|
|
2908
|
+
description: "List all secret-policy-rules",
|
|
2909
|
+
use_case: "list_all",
|
|
2910
|
+
},
|
|
2911
|
+
],
|
|
2912
|
+
confirmationRequired: false,
|
|
2913
|
+
parameterExamples: {
|
|
2914
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2915
|
+
namespace: "Ns1",
|
|
2916
|
+
},
|
|
2917
|
+
validationRules: {},
|
|
2918
|
+
operationMetadata: {
|
|
2919
|
+
common_errors: [
|
|
2920
|
+
{
|
|
2921
|
+
code: 401,
|
|
2922
|
+
message: "Authentication required",
|
|
2923
|
+
solution: "Provide valid API credentials",
|
|
2924
|
+
},
|
|
2925
|
+
{
|
|
2926
|
+
code: 403,
|
|
2927
|
+
message: "Permission denied",
|
|
2928
|
+
solution: "Check access permissions for this operation",
|
|
2929
|
+
},
|
|
2930
|
+
{
|
|
2931
|
+
code: 404,
|
|
2932
|
+
message: "Resource not found",
|
|
2933
|
+
solution: "Verify resource name, namespace, and path",
|
|
2934
|
+
},
|
|
2935
|
+
{
|
|
2936
|
+
code: 409,
|
|
2937
|
+
message: "Resource already exists",
|
|
2938
|
+
solution: "Use different name or update existing resource",
|
|
2939
|
+
},
|
|
2940
|
+
{
|
|
2941
|
+
code: 429,
|
|
2942
|
+
message: "Rate limit exceeded",
|
|
2943
|
+
solution: "Wait before retrying the operation",
|
|
2944
|
+
},
|
|
2945
|
+
{
|
|
2946
|
+
code: 500,
|
|
2947
|
+
message: "Server error",
|
|
2948
|
+
solution: "Retry operation or contact support",
|
|
2949
|
+
},
|
|
2950
|
+
],
|
|
2951
|
+
conditions: {
|
|
2952
|
+
postconditions: [],
|
|
2953
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
2954
|
+
},
|
|
2955
|
+
confirmation_required: false,
|
|
2956
|
+
danger_level: "low",
|
|
2957
|
+
examples: [
|
|
2958
|
+
{
|
|
2959
|
+
command: "f5xcctl secret_management secret-policy-rule list --namespace {namespace}",
|
|
2960
|
+
description: "List all secret-policy-rules",
|
|
2961
|
+
use_case: "list_all",
|
|
2962
|
+
},
|
|
2963
|
+
],
|
|
2964
|
+
field_docs: {},
|
|
2965
|
+
optional_fields: [],
|
|
2966
|
+
performance_impact: {
|
|
2967
|
+
latency: "moderate",
|
|
2968
|
+
resource_usage: "moderate",
|
|
2969
|
+
},
|
|
2970
|
+
purpose: "List all secret-policy-rules",
|
|
2971
|
+
required_fields: ["path.namespace"],
|
|
2972
|
+
side_effects: {},
|
|
2973
|
+
},
|
|
2974
|
+
},
|
|
2975
|
+
{
|
|
2976
|
+
toolName: "f5xc-api-blindfold-secret-policy-rule-update",
|
|
2977
|
+
method: "PUT",
|
|
2978
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/secret_policy_rules/{metadata.name}",
|
|
2979
|
+
operation: "update",
|
|
2980
|
+
domain: "blindfold",
|
|
2981
|
+
resource: "secret-policy-rule",
|
|
2982
|
+
summary: "Replace Secret Policy Rule.",
|
|
2983
|
+
description: "Replace secret_policy_rule creates a new object in storage backend for metadata.namespace.",
|
|
2984
|
+
pathParameters: [
|
|
2985
|
+
{
|
|
2986
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
2987
|
+
in: "path",
|
|
2988
|
+
name: "metadata.name",
|
|
2989
|
+
required: true,
|
|
2990
|
+
schema: {
|
|
2991
|
+
type: "string",
|
|
2992
|
+
},
|
|
2993
|
+
"x-displayname": "Name",
|
|
2994
|
+
"x-ves-example": "Example-corp-web.",
|
|
2995
|
+
},
|
|
2996
|
+
{
|
|
2997
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
2998
|
+
in: "path",
|
|
2999
|
+
name: "metadata.namespace",
|
|
3000
|
+
required: true,
|
|
3001
|
+
schema: {
|
|
3002
|
+
type: "string",
|
|
3003
|
+
},
|
|
3004
|
+
"x-displayname": "Namespace",
|
|
3005
|
+
"x-ves-example": "Staging",
|
|
3006
|
+
},
|
|
3007
|
+
],
|
|
3008
|
+
queryParameters: [],
|
|
3009
|
+
requestBodySchema: {
|
|
3010
|
+
$ref: "#/components/schemas/secret_policy_ruleReplaceRequest",
|
|
3011
|
+
},
|
|
3012
|
+
responseSchema: {
|
|
3013
|
+
$ref: "#/components/schemas/secret_policy_ruleReplaceResponse",
|
|
3014
|
+
},
|
|
3015
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
3016
|
+
operationId: "ves.io.schema.secret_policy_rule.API.Replace",
|
|
3017
|
+
tags: ["Security"],
|
|
3018
|
+
sourceFile: "domains/blindfold.json",
|
|
3019
|
+
displayName: null,
|
|
3020
|
+
dangerLevel: "medium",
|
|
3021
|
+
sideEffects: {
|
|
3022
|
+
modifies: ["secret-policy-rule"],
|
|
3023
|
+
},
|
|
3024
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3025
|
+
cliExamples: [
|
|
3026
|
+
{
|
|
3027
|
+
command: "f5xcctl secret_management secret-policy-rule update {name} --namespace {namespace} -f {file}.yaml",
|
|
3028
|
+
description: "Update secret-policy-rule",
|
|
3029
|
+
use_case: "update",
|
|
3030
|
+
},
|
|
3031
|
+
],
|
|
3032
|
+
confirmationRequired: false,
|
|
3033
|
+
parameterExamples: {
|
|
3034
|
+
"metadata.name": "Example-corp-web.",
|
|
3035
|
+
"metadata.namespace": "Staging",
|
|
3036
|
+
},
|
|
3037
|
+
validationRules: {},
|
|
3038
|
+
operationMetadata: {
|
|
3039
|
+
common_errors: [
|
|
3040
|
+
{
|
|
3041
|
+
code: 401,
|
|
3042
|
+
message: "Authentication required",
|
|
3043
|
+
solution: "Provide valid API credentials",
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
code: 403,
|
|
3047
|
+
message: "Permission denied",
|
|
3048
|
+
solution: "Check access permissions for this operation",
|
|
3049
|
+
},
|
|
3050
|
+
{
|
|
3051
|
+
code: 404,
|
|
3052
|
+
message: "Resource not found",
|
|
3053
|
+
solution: "Verify resource name, namespace, and path",
|
|
3054
|
+
},
|
|
3055
|
+
{
|
|
3056
|
+
code: 409,
|
|
3057
|
+
message: "Resource already exists",
|
|
3058
|
+
solution: "Use different name or update existing resource",
|
|
3059
|
+
},
|
|
3060
|
+
{
|
|
3061
|
+
code: 429,
|
|
3062
|
+
message: "Rate limit exceeded",
|
|
3063
|
+
solution: "Wait before retrying the operation",
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
code: 500,
|
|
3067
|
+
message: "Server error",
|
|
3068
|
+
solution: "Retry operation or contact support",
|
|
3069
|
+
},
|
|
3070
|
+
],
|
|
3071
|
+
conditions: {
|
|
3072
|
+
postconditions: ["Resource updated with new values"],
|
|
3073
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3074
|
+
},
|
|
3075
|
+
confirmation_required: false,
|
|
3076
|
+
danger_level: "medium",
|
|
3077
|
+
examples: [
|
|
3078
|
+
{
|
|
3079
|
+
command: "f5xcctl secret_management secret-policy-rule update {name} --namespace {namespace} -f {file}.yaml",
|
|
3080
|
+
description: "Update secret-policy-rule",
|
|
3081
|
+
use_case: "update",
|
|
3082
|
+
},
|
|
3083
|
+
],
|
|
3084
|
+
field_docs: {},
|
|
3085
|
+
optional_fields: [],
|
|
3086
|
+
performance_impact: {
|
|
3087
|
+
latency: "low",
|
|
3088
|
+
resource_usage: "low",
|
|
3089
|
+
},
|
|
3090
|
+
purpose: "Replace existing secret-policy-rule",
|
|
3091
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3092
|
+
side_effects: {
|
|
3093
|
+
modifies: ["secret-policy-rule"],
|
|
3094
|
+
},
|
|
3095
|
+
},
|
|
3096
|
+
},
|
|
3097
|
+
{
|
|
3098
|
+
toolName: "f5xc-api-blindfold-secret-policy-update",
|
|
3099
|
+
method: "PUT",
|
|
3100
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/secret_policys/{metadata.name}",
|
|
3101
|
+
operation: "update",
|
|
3102
|
+
domain: "blindfold",
|
|
3103
|
+
resource: "secret-policy",
|
|
3104
|
+
summary: "Replace Secret Policy.",
|
|
3105
|
+
description: "Replace secret_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
3106
|
+
pathParameters: [
|
|
3107
|
+
{
|
|
3108
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
3109
|
+
in: "path",
|
|
3110
|
+
name: "metadata.name",
|
|
3111
|
+
required: true,
|
|
3112
|
+
schema: {
|
|
3113
|
+
type: "string",
|
|
3114
|
+
},
|
|
3115
|
+
"x-displayname": "Name",
|
|
3116
|
+
"x-ves-example": "Example-corp-web.",
|
|
3117
|
+
},
|
|
3118
|
+
{
|
|
3119
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
3120
|
+
in: "path",
|
|
3121
|
+
name: "metadata.namespace",
|
|
3122
|
+
required: true,
|
|
3123
|
+
schema: {
|
|
3124
|
+
type: "string",
|
|
3125
|
+
},
|
|
3126
|
+
"x-displayname": "Namespace",
|
|
3127
|
+
"x-ves-example": "Staging",
|
|
3128
|
+
},
|
|
3129
|
+
],
|
|
3130
|
+
queryParameters: [],
|
|
3131
|
+
requestBodySchema: {
|
|
3132
|
+
$ref: "#/components/schemas/secret_policyReplaceRequest",
|
|
3133
|
+
},
|
|
3134
|
+
responseSchema: {
|
|
3135
|
+
$ref: "#/components/schemas/secret_policyReplaceResponse",
|
|
3136
|
+
},
|
|
3137
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
3138
|
+
operationId: "ves.io.schema.secret_policy.API.Replace",
|
|
3139
|
+
tags: ["Security"],
|
|
3140
|
+
sourceFile: "domains/blindfold.json",
|
|
3141
|
+
displayName: null,
|
|
3142
|
+
dangerLevel: "medium",
|
|
3143
|
+
sideEffects: {
|
|
3144
|
+
modifies: ["secret-policy"],
|
|
3145
|
+
},
|
|
3146
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3147
|
+
cliExamples: [
|
|
3148
|
+
{
|
|
3149
|
+
command: "f5xcctl secret_management secret-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3150
|
+
description: "Update secret-policy",
|
|
3151
|
+
use_case: "update",
|
|
3152
|
+
},
|
|
3153
|
+
],
|
|
3154
|
+
confirmationRequired: false,
|
|
3155
|
+
parameterExamples: {
|
|
3156
|
+
"metadata.name": "Example-corp-web.",
|
|
3157
|
+
"metadata.namespace": "Staging",
|
|
3158
|
+
},
|
|
3159
|
+
validationRules: {},
|
|
3160
|
+
operationMetadata: {
|
|
3161
|
+
common_errors: [
|
|
3162
|
+
{
|
|
3163
|
+
code: 401,
|
|
3164
|
+
message: "Authentication required",
|
|
3165
|
+
solution: "Provide valid API credentials",
|
|
3166
|
+
},
|
|
3167
|
+
{
|
|
3168
|
+
code: 403,
|
|
3169
|
+
message: "Permission denied",
|
|
3170
|
+
solution: "Check access permissions for this operation",
|
|
3171
|
+
},
|
|
3172
|
+
{
|
|
3173
|
+
code: 404,
|
|
3174
|
+
message: "Resource not found",
|
|
3175
|
+
solution: "Verify resource name, namespace, and path",
|
|
3176
|
+
},
|
|
3177
|
+
{
|
|
3178
|
+
code: 409,
|
|
3179
|
+
message: "Resource already exists",
|
|
3180
|
+
solution: "Use different name or update existing resource",
|
|
3181
|
+
},
|
|
3182
|
+
{
|
|
3183
|
+
code: 429,
|
|
3184
|
+
message: "Rate limit exceeded",
|
|
3185
|
+
solution: "Wait before retrying the operation",
|
|
3186
|
+
},
|
|
3187
|
+
{
|
|
3188
|
+
code: 500,
|
|
3189
|
+
message: "Server error",
|
|
3190
|
+
solution: "Retry operation or contact support",
|
|
3191
|
+
},
|
|
3192
|
+
],
|
|
3193
|
+
conditions: {
|
|
3194
|
+
postconditions: ["Resource updated with new values"],
|
|
3195
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3196
|
+
},
|
|
3197
|
+
confirmation_required: false,
|
|
3198
|
+
danger_level: "medium",
|
|
3199
|
+
examples: [
|
|
3200
|
+
{
|
|
3201
|
+
command: "f5xcctl secret_management secret-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3202
|
+
description: "Update secret-policy",
|
|
3203
|
+
use_case: "update",
|
|
3204
|
+
},
|
|
3205
|
+
],
|
|
3206
|
+
field_docs: {},
|
|
3207
|
+
optional_fields: [],
|
|
3208
|
+
performance_impact: {
|
|
3209
|
+
latency: "low",
|
|
3210
|
+
resource_usage: "low",
|
|
3211
|
+
},
|
|
3212
|
+
purpose: "Replace existing secret-policy",
|
|
3213
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3214
|
+
side_effects: {
|
|
3215
|
+
modifies: ["secret-policy"],
|
|
3216
|
+
},
|
|
3217
|
+
},
|
|
3218
|
+
},
|
|
3219
|
+
{
|
|
3220
|
+
toolName: "f5xc-api-blindfold-softdelete-create",
|
|
3221
|
+
method: "POST",
|
|
3222
|
+
path: "/api/secret_management/namespaces/{namespace}/secret_policy/{name}/softdelete",
|
|
3223
|
+
operation: "create",
|
|
3224
|
+
domain: "blindfold",
|
|
3225
|
+
resource: "softdelete",
|
|
3226
|
+
summary: "DELETE secret policy with given policy name.",
|
|
3227
|
+
description: "Deletepolicy CustomAPI.",
|
|
3228
|
+
pathParameters: [
|
|
3229
|
+
{
|
|
3230
|
+
description: "Name\n\nx-required\nName of the secret policy.",
|
|
3231
|
+
in: "path",
|
|
3232
|
+
name: "name",
|
|
3233
|
+
required: true,
|
|
3234
|
+
schema: {
|
|
3235
|
+
type: "string",
|
|
3236
|
+
},
|
|
3237
|
+
"x-displayname": "Name",
|
|
3238
|
+
"x-ves-example": "Site-secret-policy.",
|
|
3239
|
+
},
|
|
3240
|
+
{
|
|
3241
|
+
description: "Namespace\n\nx-required\nNamespace of the secret policy.",
|
|
3242
|
+
in: "path",
|
|
3243
|
+
name: "namespace",
|
|
3244
|
+
required: true,
|
|
3245
|
+
schema: {
|
|
3246
|
+
type: "string",
|
|
3247
|
+
},
|
|
3248
|
+
"x-displayname": "Namespace",
|
|
3249
|
+
"x-ves-example": "System",
|
|
3250
|
+
},
|
|
3251
|
+
],
|
|
3252
|
+
queryParameters: [],
|
|
3253
|
+
requestBodySchema: {
|
|
3254
|
+
$ref: "#/components/schemas/secret_policySoftDeleteRequest",
|
|
3255
|
+
},
|
|
3256
|
+
responseSchema: {
|
|
3257
|
+
$ref: "#/components/schemas/secret_policySoftDeleteResponse",
|
|
3258
|
+
},
|
|
3259
|
+
requiredParams: ["body", "name", "namespace"],
|
|
3260
|
+
operationId: "ves.io.schema.secret_policy.CustomAPI.DeletePolicy",
|
|
3261
|
+
tags: ["Security"],
|
|
3262
|
+
sourceFile: "domains/blindfold.json",
|
|
3263
|
+
displayName: null,
|
|
3264
|
+
dangerLevel: "medium",
|
|
3265
|
+
sideEffects: {
|
|
3266
|
+
creates: ["softdelete"],
|
|
3267
|
+
},
|
|
3268
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
3269
|
+
cliExamples: [
|
|
3270
|
+
{
|
|
3271
|
+
command: "f5xcctl secret_management softdelete create -f {file}.yaml",
|
|
3272
|
+
description: "Create from YAML file",
|
|
3273
|
+
use_case: "file_based",
|
|
3274
|
+
},
|
|
3275
|
+
{
|
|
3276
|
+
command: "f5xcctl secret_management softdelete create {name} --namespace {namespace}",
|
|
3277
|
+
description: "Create softdelete",
|
|
3278
|
+
use_case: "basic_create",
|
|
3279
|
+
},
|
|
3280
|
+
],
|
|
3281
|
+
confirmationRequired: false,
|
|
3282
|
+
parameterExamples: {
|
|
3283
|
+
name: "Site-secret-policy.",
|
|
3284
|
+
namespace: "System",
|
|
3285
|
+
},
|
|
3286
|
+
validationRules: {},
|
|
3287
|
+
operationMetadata: {
|
|
3288
|
+
common_errors: [
|
|
3289
|
+
{
|
|
3290
|
+
code: 401,
|
|
3291
|
+
message: "Authentication required",
|
|
3292
|
+
solution: "Provide valid API credentials",
|
|
3293
|
+
},
|
|
3294
|
+
{
|
|
3295
|
+
code: 403,
|
|
3296
|
+
message: "Permission denied",
|
|
3297
|
+
solution: "Check access permissions for this operation",
|
|
3298
|
+
},
|
|
3299
|
+
{
|
|
3300
|
+
code: 404,
|
|
3301
|
+
message: "Resource not found",
|
|
3302
|
+
solution: "Verify resource name, namespace, and path",
|
|
3303
|
+
},
|
|
3304
|
+
{
|
|
3305
|
+
code: 409,
|
|
3306
|
+
message: "Resource already exists",
|
|
3307
|
+
solution: "Use different name or update existing resource",
|
|
3308
|
+
},
|
|
3309
|
+
{
|
|
3310
|
+
code: 429,
|
|
3311
|
+
message: "Rate limit exceeded",
|
|
3312
|
+
solution: "Wait before retrying the operation",
|
|
3313
|
+
},
|
|
3314
|
+
{
|
|
3315
|
+
code: 500,
|
|
3316
|
+
message: "Server error",
|
|
3317
|
+
solution: "Retry operation or contact support",
|
|
3318
|
+
},
|
|
3319
|
+
],
|
|
3320
|
+
conditions: {
|
|
3321
|
+
postconditions: ["Softdelete resource created", "Resource assigned unique identifier"],
|
|
3322
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3323
|
+
},
|
|
3324
|
+
confirmation_required: false,
|
|
3325
|
+
danger_level: "medium",
|
|
3326
|
+
examples: [
|
|
3327
|
+
{
|
|
3328
|
+
command: "f5xcctl secret_management softdelete create {name} --namespace {namespace}",
|
|
3329
|
+
description: "Create softdelete",
|
|
3330
|
+
use_case: "basic_create",
|
|
3331
|
+
},
|
|
3332
|
+
{
|
|
3333
|
+
command: "f5xcctl secret_management softdelete create -f {file}.yaml",
|
|
3334
|
+
description: "Create from YAML file",
|
|
3335
|
+
use_case: "file_based",
|
|
3336
|
+
},
|
|
3337
|
+
],
|
|
3338
|
+
field_docs: {},
|
|
3339
|
+
optional_fields: [],
|
|
3340
|
+
performance_impact: {
|
|
3341
|
+
latency: "low",
|
|
3342
|
+
resource_usage: "low",
|
|
3343
|
+
},
|
|
3344
|
+
purpose: "Create new softdelete",
|
|
3345
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
3346
|
+
side_effects: {
|
|
3347
|
+
creates: ["softdelete"],
|
|
3348
|
+
},
|
|
3349
|
+
},
|
|
3350
|
+
},
|
|
3351
|
+
{
|
|
3352
|
+
toolName: "f5xc-api-blindfold-voltshare-admin-policy-create",
|
|
3353
|
+
method: "POST",
|
|
3354
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/voltshare_admin_policys",
|
|
3355
|
+
operation: "create",
|
|
3356
|
+
domain: "blindfold",
|
|
3357
|
+
resource: "voltshare-admin-policy",
|
|
3358
|
+
summary: "Create VoltShare Admin Policy.",
|
|
3359
|
+
description: "Create voltshare_admin_policy creates a new object in the storage backend for metadata.namespace.",
|
|
3360
|
+
pathParameters: [
|
|
3361
|
+
{
|
|
3362
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
3363
|
+
in: "path",
|
|
3364
|
+
name: "metadata.namespace",
|
|
3365
|
+
required: true,
|
|
3366
|
+
schema: {
|
|
3367
|
+
type: "string",
|
|
3368
|
+
},
|
|
3369
|
+
"x-displayname": "Namespace",
|
|
3370
|
+
"x-ves-example": "Staging",
|
|
3371
|
+
},
|
|
3372
|
+
],
|
|
3373
|
+
queryParameters: [],
|
|
3374
|
+
requestBodySchema: {
|
|
3375
|
+
$ref: "#/components/schemas/voltshare_admin_policyCreateRequest",
|
|
3376
|
+
},
|
|
3377
|
+
responseSchema: {
|
|
3378
|
+
$ref: "#/components/schemas/voltshare_admin_policyCreateResponse",
|
|
3379
|
+
},
|
|
3380
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
3381
|
+
operationId: "ves.io.schema.voltshare_admin_policy.API.Create",
|
|
3382
|
+
tags: ["Security"],
|
|
3383
|
+
sourceFile: "domains/blindfold.json",
|
|
3384
|
+
displayName: null,
|
|
3385
|
+
dangerLevel: "medium",
|
|
3386
|
+
sideEffects: {
|
|
3387
|
+
creates: ["voltshare-admin-policy"],
|
|
3388
|
+
},
|
|
3389
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
3390
|
+
cliExamples: [
|
|
3391
|
+
{
|
|
3392
|
+
command: "f5xcctl secret_management voltshare-admin-policy create -f {file}.yaml",
|
|
3393
|
+
description: "Create from YAML file",
|
|
3394
|
+
use_case: "file_based",
|
|
3395
|
+
},
|
|
3396
|
+
{
|
|
3397
|
+
command: "f5xcctl secret_management voltshare-admin-policy create {name} --namespace {namespace}",
|
|
3398
|
+
description: "Create voltshare-admin-policy",
|
|
3399
|
+
use_case: "basic_create",
|
|
3400
|
+
},
|
|
3401
|
+
],
|
|
3402
|
+
confirmationRequired: false,
|
|
3403
|
+
parameterExamples: {
|
|
3404
|
+
"metadata.namespace": "Staging",
|
|
3405
|
+
},
|
|
3406
|
+
validationRules: {},
|
|
3407
|
+
operationMetadata: {
|
|
3408
|
+
common_errors: [
|
|
3409
|
+
{
|
|
3410
|
+
code: 401,
|
|
3411
|
+
message: "Authentication required",
|
|
3412
|
+
solution: "Provide valid API credentials",
|
|
3413
|
+
},
|
|
3414
|
+
{
|
|
3415
|
+
code: 403,
|
|
3416
|
+
message: "Permission denied",
|
|
3417
|
+
solution: "Check access permissions for this operation",
|
|
3418
|
+
},
|
|
3419
|
+
{
|
|
3420
|
+
code: 404,
|
|
3421
|
+
message: "Resource not found",
|
|
3422
|
+
solution: "Verify resource name, namespace, and path",
|
|
3423
|
+
},
|
|
3424
|
+
{
|
|
3425
|
+
code: 409,
|
|
3426
|
+
message: "Resource already exists",
|
|
3427
|
+
solution: "Use different name or update existing resource",
|
|
3428
|
+
},
|
|
3429
|
+
{
|
|
3430
|
+
code: 429,
|
|
3431
|
+
message: "Rate limit exceeded",
|
|
3432
|
+
solution: "Wait before retrying the operation",
|
|
3433
|
+
},
|
|
3434
|
+
{
|
|
3435
|
+
code: 500,
|
|
3436
|
+
message: "Server error",
|
|
3437
|
+
solution: "Retry operation or contact support",
|
|
3438
|
+
},
|
|
3439
|
+
],
|
|
3440
|
+
conditions: {
|
|
3441
|
+
postconditions: [
|
|
3442
|
+
"Voltshare-admin-policy resource created",
|
|
3443
|
+
"Resource assigned unique identifier",
|
|
3444
|
+
],
|
|
3445
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3446
|
+
},
|
|
3447
|
+
confirmation_required: false,
|
|
3448
|
+
danger_level: "medium",
|
|
3449
|
+
examples: [
|
|
3450
|
+
{
|
|
3451
|
+
command: "f5xcctl secret_management voltshare-admin-policy create {name} --namespace {namespace}",
|
|
3452
|
+
description: "Create voltshare-admin-policy",
|
|
3453
|
+
use_case: "basic_create",
|
|
3454
|
+
},
|
|
3455
|
+
{
|
|
3456
|
+
command: "f5xcctl secret_management voltshare-admin-policy create -f {file}.yaml",
|
|
3457
|
+
description: "Create from YAML file",
|
|
3458
|
+
use_case: "file_based",
|
|
3459
|
+
},
|
|
3460
|
+
],
|
|
3461
|
+
field_docs: {},
|
|
3462
|
+
optional_fields: [],
|
|
3463
|
+
performance_impact: {
|
|
3464
|
+
latency: "low",
|
|
3465
|
+
resource_usage: "low",
|
|
3466
|
+
},
|
|
3467
|
+
purpose: "Create new voltshare-admin-policy",
|
|
3468
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
3469
|
+
side_effects: {
|
|
3470
|
+
creates: ["voltshare-admin-policy"],
|
|
3471
|
+
},
|
|
3472
|
+
},
|
|
3473
|
+
},
|
|
3474
|
+
{
|
|
3475
|
+
toolName: "f5xc-api-blindfold-voltshare-admin-policy-delete",
|
|
3476
|
+
method: "DELETE",
|
|
3477
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare_admin_policys/{name}",
|
|
3478
|
+
operation: "delete",
|
|
3479
|
+
domain: "blindfold",
|
|
3480
|
+
resource: "voltshare-admin-policy",
|
|
3481
|
+
summary: "DELETE VoltShare Admin Policy.",
|
|
3482
|
+
description: "DELETE the specified voltshare_admin_policy.",
|
|
3483
|
+
pathParameters: [
|
|
3484
|
+
{
|
|
3485
|
+
description: "Name\nName of the configuration object.",
|
|
3486
|
+
in: "path",
|
|
3487
|
+
name: "name",
|
|
3488
|
+
required: true,
|
|
3489
|
+
schema: {
|
|
3490
|
+
type: "string",
|
|
3491
|
+
},
|
|
3492
|
+
"x-displayname": "Name",
|
|
3493
|
+
"x-ves-example": "Name",
|
|
3494
|
+
},
|
|
3495
|
+
{
|
|
3496
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
3497
|
+
in: "path",
|
|
3498
|
+
name: "namespace",
|
|
3499
|
+
required: true,
|
|
3500
|
+
schema: {
|
|
3501
|
+
type: "string",
|
|
3502
|
+
},
|
|
3503
|
+
"x-displayname": "Namespace",
|
|
3504
|
+
"x-ves-example": "Ns1",
|
|
3505
|
+
},
|
|
3506
|
+
],
|
|
3507
|
+
queryParameters: [],
|
|
3508
|
+
requestBodySchema: {
|
|
3509
|
+
$ref: "#/components/schemas/voltshare_admin_policyDeleteRequest",
|
|
3510
|
+
},
|
|
3511
|
+
responseSchema: {},
|
|
3512
|
+
requiredParams: ["body", "name", "namespace"],
|
|
3513
|
+
operationId: "ves.io.schema.voltshare_admin_policy.API.Delete",
|
|
3514
|
+
tags: ["Security"],
|
|
3515
|
+
sourceFile: "domains/blindfold.json",
|
|
3516
|
+
displayName: null,
|
|
3517
|
+
dangerLevel: "high",
|
|
3518
|
+
sideEffects: {
|
|
3519
|
+
deletes: ["voltshare-admin-policy", "contained_resources"],
|
|
3520
|
+
},
|
|
3521
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3522
|
+
cliExamples: [
|
|
3523
|
+
{
|
|
3524
|
+
command: "f5xcctl secret_management voltshare-admin-policy delete {name} --namespace {namespace}",
|
|
3525
|
+
description: "Delete voltshare-admin-policy",
|
|
3526
|
+
use_case: "delete",
|
|
3527
|
+
},
|
|
3528
|
+
],
|
|
3529
|
+
confirmationRequired: true,
|
|
3530
|
+
parameterExamples: {
|
|
3531
|
+
name: "Name",
|
|
3532
|
+
namespace: "Ns1",
|
|
3533
|
+
},
|
|
3534
|
+
validationRules: {},
|
|
3535
|
+
operationMetadata: {
|
|
3536
|
+
common_errors: [
|
|
3537
|
+
{
|
|
3538
|
+
code: 401,
|
|
3539
|
+
message: "Authentication required",
|
|
3540
|
+
solution: "Provide valid API credentials",
|
|
3541
|
+
},
|
|
3542
|
+
{
|
|
3543
|
+
code: 403,
|
|
3544
|
+
message: "Permission denied",
|
|
3545
|
+
solution: "Check access permissions for this operation",
|
|
3546
|
+
},
|
|
3547
|
+
{
|
|
3548
|
+
code: 404,
|
|
3549
|
+
message: "Resource not found",
|
|
3550
|
+
solution: "Verify resource name, namespace, and path",
|
|
3551
|
+
},
|
|
3552
|
+
{
|
|
3553
|
+
code: 409,
|
|
3554
|
+
message: "Resource already exists",
|
|
3555
|
+
solution: "Use different name or update existing resource",
|
|
3556
|
+
},
|
|
3557
|
+
{
|
|
3558
|
+
code: 429,
|
|
3559
|
+
message: "Rate limit exceeded",
|
|
3560
|
+
solution: "Wait before retrying the operation",
|
|
3561
|
+
},
|
|
3562
|
+
{
|
|
3563
|
+
code: 500,
|
|
3564
|
+
message: "Server error",
|
|
3565
|
+
solution: "Retry operation or contact support",
|
|
3566
|
+
},
|
|
3567
|
+
],
|
|
3568
|
+
conditions: {
|
|
3569
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
3570
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3571
|
+
},
|
|
3572
|
+
confirmation_required: true,
|
|
3573
|
+
danger_level: "high",
|
|
3574
|
+
examples: [
|
|
3575
|
+
{
|
|
3576
|
+
command: "f5xcctl secret_management voltshare-admin-policy delete {name} --namespace {namespace}",
|
|
3577
|
+
description: "Delete voltshare-admin-policy",
|
|
3578
|
+
use_case: "delete",
|
|
3579
|
+
},
|
|
3580
|
+
],
|
|
3581
|
+
field_docs: {},
|
|
3582
|
+
optional_fields: [],
|
|
3583
|
+
performance_impact: {
|
|
3584
|
+
latency: "high",
|
|
3585
|
+
resource_usage: "moderate",
|
|
3586
|
+
},
|
|
3587
|
+
purpose: "Delete voltshare-admin-policy",
|
|
3588
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3589
|
+
side_effects: {
|
|
3590
|
+
deletes: ["voltshare-admin-policy", "contained_resources"],
|
|
3591
|
+
},
|
|
3592
|
+
},
|
|
3593
|
+
},
|
|
3594
|
+
{
|
|
3595
|
+
toolName: "f5xc-api-blindfold-voltshare-admin-policy-get",
|
|
3596
|
+
method: "GET",
|
|
3597
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare_admin_policys/{name}",
|
|
3598
|
+
operation: "get",
|
|
3599
|
+
domain: "blindfold",
|
|
3600
|
+
resource: "voltshare-admin-policy",
|
|
3601
|
+
summary: "GET VoltShare Admin Policy.",
|
|
3602
|
+
description: "GET voltshare_admin_policy reads a given object from storage backend for metadata.namespace.",
|
|
3603
|
+
pathParameters: [
|
|
3604
|
+
{
|
|
3605
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
3606
|
+
in: "path",
|
|
3607
|
+
name: "name",
|
|
3608
|
+
required: true,
|
|
3609
|
+
schema: {
|
|
3610
|
+
type: "string",
|
|
3611
|
+
},
|
|
3612
|
+
"x-displayname": "Name",
|
|
3613
|
+
"x-ves-example": "Name",
|
|
3614
|
+
},
|
|
3615
|
+
{
|
|
3616
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
3617
|
+
in: "path",
|
|
3618
|
+
name: "namespace",
|
|
3619
|
+
required: true,
|
|
3620
|
+
schema: {
|
|
3621
|
+
type: "string",
|
|
3622
|
+
},
|
|
3623
|
+
"x-displayname": "Namespace",
|
|
3624
|
+
"x-ves-example": "Ns1",
|
|
3625
|
+
},
|
|
3626
|
+
],
|
|
3627
|
+
queryParameters: [
|
|
3628
|
+
{
|
|
3629
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
3630
|
+
in: "query",
|
|
3631
|
+
name: "response_format",
|
|
3632
|
+
required: false,
|
|
3633
|
+
schema: {
|
|
3634
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
3635
|
+
enum: [
|
|
3636
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
3637
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
3638
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
3639
|
+
"GET_RSP_FORMAT_STATUS",
|
|
3640
|
+
"GET_RSP_FORMAT_READ",
|
|
3641
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
3642
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
3643
|
+
],
|
|
3644
|
+
type: "string",
|
|
3645
|
+
},
|
|
3646
|
+
"x-displayname": "Broken Referred Objects.",
|
|
3647
|
+
},
|
|
3648
|
+
],
|
|
3649
|
+
requestBodySchema: null,
|
|
3650
|
+
responseSchema: {
|
|
3651
|
+
$ref: "#/components/schemas/voltshare_admin_policyGetResponse",
|
|
3652
|
+
},
|
|
3653
|
+
requiredParams: ["name", "namespace"],
|
|
3654
|
+
operationId: "ves.io.schema.voltshare_admin_policy.API.Get",
|
|
3655
|
+
tags: ["Security"],
|
|
3656
|
+
sourceFile: "domains/blindfold.json",
|
|
3657
|
+
displayName: null,
|
|
3658
|
+
dangerLevel: "low",
|
|
3659
|
+
sideEffects: null,
|
|
3660
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3661
|
+
cliExamples: [
|
|
3662
|
+
{
|
|
3663
|
+
command: "f5xcctl secret_management voltshare-admin-policy get {name} --namespace {namespace}",
|
|
3664
|
+
description: "Get specific voltshare-admin-policy",
|
|
3665
|
+
use_case: "get_specific",
|
|
3666
|
+
},
|
|
3667
|
+
],
|
|
3668
|
+
confirmationRequired: false,
|
|
3669
|
+
parameterExamples: {
|
|
3670
|
+
name: "Name",
|
|
3671
|
+
namespace: "Ns1",
|
|
3672
|
+
},
|
|
3673
|
+
validationRules: {},
|
|
3674
|
+
operationMetadata: {
|
|
3675
|
+
common_errors: [
|
|
3676
|
+
{
|
|
3677
|
+
code: 401,
|
|
3678
|
+
message: "Authentication required",
|
|
3679
|
+
solution: "Provide valid API credentials",
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
code: 403,
|
|
3683
|
+
message: "Permission denied",
|
|
3684
|
+
solution: "Check access permissions for this operation",
|
|
3685
|
+
},
|
|
3686
|
+
{
|
|
3687
|
+
code: 404,
|
|
3688
|
+
message: "Resource not found",
|
|
3689
|
+
solution: "Verify resource name, namespace, and path",
|
|
3690
|
+
},
|
|
3691
|
+
{
|
|
3692
|
+
code: 409,
|
|
3693
|
+
message: "Resource already exists",
|
|
3694
|
+
solution: "Use different name or update existing resource",
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
code: 429,
|
|
3698
|
+
message: "Rate limit exceeded",
|
|
3699
|
+
solution: "Wait before retrying the operation",
|
|
3700
|
+
},
|
|
3701
|
+
{
|
|
3702
|
+
code: 500,
|
|
3703
|
+
message: "Server error",
|
|
3704
|
+
solution: "Retry operation or contact support",
|
|
3705
|
+
},
|
|
3706
|
+
],
|
|
3707
|
+
conditions: {
|
|
3708
|
+
postconditions: [],
|
|
3709
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3710
|
+
},
|
|
3711
|
+
confirmation_required: false,
|
|
3712
|
+
danger_level: "low",
|
|
3713
|
+
examples: [
|
|
3714
|
+
{
|
|
3715
|
+
command: "f5xcctl secret_management voltshare-admin-policy get {name} --namespace {namespace}",
|
|
3716
|
+
description: "Get specific voltshare-admin-policy",
|
|
3717
|
+
use_case: "get_specific",
|
|
3718
|
+
},
|
|
3719
|
+
],
|
|
3720
|
+
field_docs: {},
|
|
3721
|
+
optional_fields: [],
|
|
3722
|
+
performance_impact: {
|
|
3723
|
+
latency: "low",
|
|
3724
|
+
resource_usage: "low",
|
|
3725
|
+
},
|
|
3726
|
+
purpose: "Retrieve specific voltshare-admin-policy",
|
|
3727
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3728
|
+
side_effects: {},
|
|
3729
|
+
},
|
|
3730
|
+
},
|
|
3731
|
+
{
|
|
3732
|
+
toolName: "f5xc-api-blindfold-voltshare-admin-policy-list",
|
|
3733
|
+
method: "GET",
|
|
3734
|
+
path: "/api/secret_management/namespaces/{namespace}/voltshare_admin_policys",
|
|
3735
|
+
operation: "list",
|
|
3736
|
+
domain: "blindfold",
|
|
3737
|
+
resource: "voltshare-admin-policy",
|
|
3738
|
+
summary: "List VoltShare Admin Policy.",
|
|
3739
|
+
description: "List the set of voltshare_admin_policy in a namespace.",
|
|
3740
|
+
pathParameters: [
|
|
3741
|
+
{
|
|
3742
|
+
description: "Namespace\nNamespace to scope the listing of voltshare_admin_policy.",
|
|
3743
|
+
in: "path",
|
|
3744
|
+
name: "namespace",
|
|
3745
|
+
required: true,
|
|
3746
|
+
schema: {
|
|
3747
|
+
type: "string",
|
|
3748
|
+
},
|
|
3749
|
+
"x-displayname": "Namespace",
|
|
3750
|
+
"x-ves-example": "Ns1",
|
|
3751
|
+
},
|
|
3752
|
+
],
|
|
3753
|
+
queryParameters: [
|
|
3754
|
+
{
|
|
3755
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
3756
|
+
in: "query",
|
|
3757
|
+
name: "label_filter",
|
|
3758
|
+
required: false,
|
|
3759
|
+
schema: {
|
|
3760
|
+
type: "string",
|
|
3761
|
+
},
|
|
3762
|
+
"x-displayname": "Label Filter.",
|
|
3763
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
3764
|
+
},
|
|
3765
|
+
{
|
|
3766
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
3767
|
+
in: "query",
|
|
3768
|
+
name: "report_fields",
|
|
3769
|
+
required: false,
|
|
3770
|
+
schema: {
|
|
3771
|
+
items: {
|
|
3772
|
+
type: "string",
|
|
3773
|
+
},
|
|
3774
|
+
type: "array",
|
|
3775
|
+
},
|
|
3776
|
+
"x-displayname": "Report Fields.",
|
|
3777
|
+
},
|
|
3778
|
+
{
|
|
3779
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
3780
|
+
in: "query",
|
|
3781
|
+
name: "report_status_fields",
|
|
3782
|
+
required: false,
|
|
3783
|
+
schema: {
|
|
3784
|
+
items: {
|
|
3785
|
+
type: "string",
|
|
3786
|
+
},
|
|
3787
|
+
type: "array",
|
|
3788
|
+
},
|
|
3789
|
+
"x-displayname": "Report Status Fields.",
|
|
3790
|
+
},
|
|
3791
|
+
],
|
|
3792
|
+
requestBodySchema: null,
|
|
3793
|
+
responseSchema: {
|
|
3794
|
+
$ref: "#/components/schemas/voltshare_admin_policyListResponse",
|
|
3795
|
+
},
|
|
3796
|
+
requiredParams: ["namespace"],
|
|
3797
|
+
operationId: "ves.io.schema.voltshare_admin_policy.API.List",
|
|
3798
|
+
tags: ["Security"],
|
|
3799
|
+
sourceFile: "domains/blindfold.json",
|
|
3800
|
+
displayName: null,
|
|
3801
|
+
dangerLevel: "low",
|
|
3802
|
+
sideEffects: null,
|
|
3803
|
+
requiredFields: ["path.namespace"],
|
|
3804
|
+
cliExamples: [
|
|
3805
|
+
{
|
|
3806
|
+
command: "f5xcctl secret_management voltshare-admin-policy list --namespace {namespace}",
|
|
3807
|
+
description: "List all voltshare-admin-policys",
|
|
3808
|
+
use_case: "list_all",
|
|
3809
|
+
},
|
|
3810
|
+
],
|
|
3811
|
+
confirmationRequired: false,
|
|
3812
|
+
parameterExamples: {
|
|
3813
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
3814
|
+
namespace: "Ns1",
|
|
3815
|
+
},
|
|
3816
|
+
validationRules: {},
|
|
3817
|
+
operationMetadata: {
|
|
3818
|
+
common_errors: [
|
|
3819
|
+
{
|
|
3820
|
+
code: 401,
|
|
3821
|
+
message: "Authentication required",
|
|
3822
|
+
solution: "Provide valid API credentials",
|
|
3823
|
+
},
|
|
3824
|
+
{
|
|
3825
|
+
code: 403,
|
|
3826
|
+
message: "Permission denied",
|
|
3827
|
+
solution: "Check access permissions for this operation",
|
|
3828
|
+
},
|
|
3829
|
+
{
|
|
3830
|
+
code: 404,
|
|
3831
|
+
message: "Resource not found",
|
|
3832
|
+
solution: "Verify resource name, namespace, and path",
|
|
3833
|
+
},
|
|
3834
|
+
{
|
|
3835
|
+
code: 409,
|
|
3836
|
+
message: "Resource already exists",
|
|
3837
|
+
solution: "Use different name or update existing resource",
|
|
3838
|
+
},
|
|
3839
|
+
{
|
|
3840
|
+
code: 429,
|
|
3841
|
+
message: "Rate limit exceeded",
|
|
3842
|
+
solution: "Wait before retrying the operation",
|
|
3843
|
+
},
|
|
3844
|
+
{
|
|
3845
|
+
code: 500,
|
|
3846
|
+
message: "Server error",
|
|
3847
|
+
solution: "Retry operation or contact support",
|
|
3848
|
+
},
|
|
3849
|
+
],
|
|
3850
|
+
conditions: {
|
|
3851
|
+
postconditions: [],
|
|
3852
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3853
|
+
},
|
|
3854
|
+
confirmation_required: false,
|
|
3855
|
+
danger_level: "low",
|
|
3856
|
+
examples: [
|
|
3857
|
+
{
|
|
3858
|
+
command: "f5xcctl secret_management voltshare-admin-policy list --namespace {namespace}",
|
|
3859
|
+
description: "List all voltshare-admin-policys",
|
|
3860
|
+
use_case: "list_all",
|
|
3861
|
+
},
|
|
3862
|
+
],
|
|
3863
|
+
field_docs: {},
|
|
3864
|
+
optional_fields: [],
|
|
3865
|
+
performance_impact: {
|
|
3866
|
+
latency: "moderate",
|
|
3867
|
+
resource_usage: "moderate",
|
|
3868
|
+
},
|
|
3869
|
+
purpose: "List all voltshare-admin-policys",
|
|
3870
|
+
required_fields: ["path.namespace"],
|
|
3871
|
+
side_effects: {},
|
|
3872
|
+
},
|
|
3873
|
+
},
|
|
3874
|
+
{
|
|
3875
|
+
toolName: "f5xc-api-blindfold-voltshare-admin-policy-update",
|
|
3876
|
+
method: "PUT",
|
|
3877
|
+
path: "/api/secret_management/namespaces/{metadata.namespace}/voltshare_admin_policys/{metadata.name}",
|
|
3878
|
+
operation: "update",
|
|
3879
|
+
domain: "blindfold",
|
|
3880
|
+
resource: "voltshare-admin-policy",
|
|
3881
|
+
summary: "Replace VoltShare Admin Policy.",
|
|
3882
|
+
description: "Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.",
|
|
3883
|
+
pathParameters: [
|
|
3884
|
+
{
|
|
3885
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
3886
|
+
in: "path",
|
|
3887
|
+
name: "metadata.name",
|
|
3888
|
+
required: true,
|
|
3889
|
+
schema: {
|
|
3890
|
+
type: "string",
|
|
3891
|
+
},
|
|
3892
|
+
"x-displayname": "Name",
|
|
3893
|
+
"x-ves-example": "Example-corp-web.",
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
|
|
3897
|
+
in: "path",
|
|
3898
|
+
name: "metadata.namespace",
|
|
3899
|
+
required: true,
|
|
3900
|
+
schema: {
|
|
3901
|
+
type: "string",
|
|
3902
|
+
},
|
|
3903
|
+
"x-displayname": "Namespace",
|
|
3904
|
+
"x-ves-example": "Staging",
|
|
3905
|
+
},
|
|
3906
|
+
],
|
|
3907
|
+
queryParameters: [],
|
|
3908
|
+
requestBodySchema: {
|
|
3909
|
+
$ref: "#/components/schemas/voltshare_admin_policyReplaceRequest",
|
|
3910
|
+
},
|
|
3911
|
+
responseSchema: {
|
|
3912
|
+
$ref: "#/components/schemas/voltshare_admin_policyReplaceResponse",
|
|
3913
|
+
},
|
|
3914
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
3915
|
+
operationId: "ves.io.schema.voltshare_admin_policy.API.Replace",
|
|
3916
|
+
tags: ["Security"],
|
|
3917
|
+
sourceFile: "domains/blindfold.json",
|
|
3918
|
+
displayName: null,
|
|
3919
|
+
dangerLevel: "medium",
|
|
3920
|
+
sideEffects: {
|
|
3921
|
+
modifies: ["voltshare-admin-policy"],
|
|
3922
|
+
},
|
|
3923
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3924
|
+
cliExamples: [
|
|
3925
|
+
{
|
|
3926
|
+
command: "f5xcctl secret_management voltshare-admin-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3927
|
+
description: "Update voltshare-admin-policy",
|
|
3928
|
+
use_case: "update",
|
|
3929
|
+
},
|
|
3930
|
+
],
|
|
3931
|
+
confirmationRequired: false,
|
|
3932
|
+
parameterExamples: {
|
|
3933
|
+
"metadata.name": "Example-corp-web.",
|
|
3934
|
+
"metadata.namespace": "Staging",
|
|
3935
|
+
},
|
|
3936
|
+
validationRules: {},
|
|
3937
|
+
operationMetadata: {
|
|
3938
|
+
common_errors: [
|
|
3939
|
+
{
|
|
3940
|
+
code: 401,
|
|
3941
|
+
message: "Authentication required",
|
|
3942
|
+
solution: "Provide valid API credentials",
|
|
3943
|
+
},
|
|
3944
|
+
{
|
|
3945
|
+
code: 403,
|
|
3946
|
+
message: "Permission denied",
|
|
3947
|
+
solution: "Check access permissions for this operation",
|
|
3948
|
+
},
|
|
3949
|
+
{
|
|
3950
|
+
code: 404,
|
|
3951
|
+
message: "Resource not found",
|
|
3952
|
+
solution: "Verify resource name, namespace, and path",
|
|
3953
|
+
},
|
|
3954
|
+
{
|
|
3955
|
+
code: 409,
|
|
3956
|
+
message: "Resource already exists",
|
|
3957
|
+
solution: "Use different name or update existing resource",
|
|
3958
|
+
},
|
|
3959
|
+
{
|
|
3960
|
+
code: 429,
|
|
3961
|
+
message: "Rate limit exceeded",
|
|
3962
|
+
solution: "Wait before retrying the operation",
|
|
3963
|
+
},
|
|
3964
|
+
{
|
|
3965
|
+
code: 500,
|
|
3966
|
+
message: "Server error",
|
|
3967
|
+
solution: "Retry operation or contact support",
|
|
3968
|
+
},
|
|
3969
|
+
],
|
|
3970
|
+
conditions: {
|
|
3971
|
+
postconditions: ["Resource updated with new values"],
|
|
3972
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
3973
|
+
},
|
|
3974
|
+
confirmation_required: false,
|
|
3975
|
+
danger_level: "medium",
|
|
3976
|
+
examples: [
|
|
3977
|
+
{
|
|
3978
|
+
command: "f5xcctl secret_management voltshare-admin-policy update {name} --namespace {namespace} -f {file}.yaml",
|
|
3979
|
+
description: "Update voltshare-admin-policy",
|
|
3980
|
+
use_case: "update",
|
|
3981
|
+
},
|
|
3982
|
+
],
|
|
3983
|
+
field_docs: {},
|
|
3984
|
+
optional_fields: [],
|
|
3985
|
+
performance_impact: {
|
|
3986
|
+
latency: "low",
|
|
3987
|
+
resource_usage: "low",
|
|
3988
|
+
},
|
|
3989
|
+
purpose: "Replace existing voltshare-admin-policy",
|
|
3990
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
3991
|
+
side_effects: {
|
|
3992
|
+
modifies: ["voltshare-admin-policy"],
|
|
3993
|
+
},
|
|
3994
|
+
},
|
|
3995
|
+
},
|
|
3996
|
+
];
|
|
3997
|
+
export default blindfoldTools;
|
|
3998
|
+
//# sourceMappingURL=index.js.map
|