@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.5.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 +355 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +202 -2
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -2
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +144 -28
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/index.d.ts +2 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -33
- package/dist/index.js.map +1 -1
- package/dist/prompts/workflows.d.ts.map +1 -1
- package/dist/prompts/workflows.js +30 -174
- package/dist/prompts/workflows.js.map +1 -1
- package/dist/resources/handlers.d.ts +0 -2
- package/dist/resources/handlers.d.ts.map +1 -1
- package/dist/resources/handlers.js +0 -51
- package/dist/resources/handlers.js.map +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +1 -2
- package/dist/server.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/discovery/execute.d.ts +1 -3
- package/dist/tools/discovery/execute.d.ts.map +1 -1
- package/dist/tools/discovery/execute.js +1 -34
- package/dist/tools/discovery/execute.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 +259 -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 +5812 -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 +858 -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 +1660 -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 +2283 -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 +3462 -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 +2264 -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 +1498 -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 +3437 -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 +2279 -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 +3585 -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 +1806 -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 +1519 -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 +1495 -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 +7427 -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 +5604 -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 +972 -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 +2858 -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 +4022 -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 +11132 -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 +7827 -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 +1598 -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 +964 -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 +3521 -4641
- 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 +1712 -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 +578 -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 +3810 -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 +18464 -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 +11494 -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 +7557 -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 +5334 -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 +2304 -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 +17560 -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 +99 -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 +1376 -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 +10103 -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 +85 -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 +3802 -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/cli/index.d.ts +0 -16
- package/dist/cli/index.d.ts.map +0 -1
- package/dist/cli/index.js +0 -116
- package/dist/cli/index.js.map +0 -1
- package/dist/cli/setup.d.ts +0 -54
- package/dist/cli/setup.d.ts.map +0 -1
- package/dist/cli/setup.js +0 -347
- package/dist/cli/setup.js.map +0 -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,2264 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for bot_and_threat_defense domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const bot_and_threat_defenseTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-botandthreatdefense-bot-defense-app-infrastructure-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/config/namespaces/{metadata.namespace}/bot_defense_app_infrastructures",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "bot_and_threat_defense",
|
|
12
|
+
resource: "bot-defense-app-infrastructure",
|
|
13
|
+
summary: "Create Bot Defense App Infrastructure.",
|
|
14
|
+
description: "Creates Bot Defense App Infrastructure in a given namespace.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
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 ""',
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "metadata.namespace",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Staging",
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
queryParameters: [],
|
|
29
|
+
requestBodySchema: {
|
|
30
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureCreateRequest",
|
|
31
|
+
},
|
|
32
|
+
responseSchema: {
|
|
33
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureCreateResponse",
|
|
34
|
+
},
|
|
35
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
36
|
+
operationId: "ves.io.schema.views.bot_defense_app_infrastructure.API.Create",
|
|
37
|
+
tags: ["Other"],
|
|
38
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["bot-defense-app-infrastructure"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
45
|
+
confirmationRequired: false,
|
|
46
|
+
parameterExamples: {
|
|
47
|
+
"metadata.namespace": "Staging",
|
|
48
|
+
},
|
|
49
|
+
validationRules: {},
|
|
50
|
+
operationMetadata: {
|
|
51
|
+
common_errors: [
|
|
52
|
+
{
|
|
53
|
+
code: 401,
|
|
54
|
+
message: "Authentication required",
|
|
55
|
+
solution: "Provide valid API credentials",
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
code: 403,
|
|
59
|
+
message: "Permission denied",
|
|
60
|
+
solution: "Check access permissions for this operation",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
code: 404,
|
|
64
|
+
message: "Resource not found",
|
|
65
|
+
solution: "Verify resource name, namespace, and path",
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
code: 409,
|
|
69
|
+
message: "Resource already exists",
|
|
70
|
+
solution: "Use different name or update existing resource",
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
code: 429,
|
|
74
|
+
message: "Rate limit exceeded",
|
|
75
|
+
solution: "Wait before retrying the operation",
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
code: 500,
|
|
79
|
+
message: "Server error",
|
|
80
|
+
solution: "Retry operation or contact support",
|
|
81
|
+
},
|
|
82
|
+
],
|
|
83
|
+
conditions: {
|
|
84
|
+
postconditions: [
|
|
85
|
+
"Bot-defense-app-infrastructure resource created",
|
|
86
|
+
"Resource assigned unique identifier",
|
|
87
|
+
],
|
|
88
|
+
prerequisites: ["Active namespace"],
|
|
89
|
+
},
|
|
90
|
+
confirmation_required: false,
|
|
91
|
+
danger_level: "medium",
|
|
92
|
+
field_docs: {},
|
|
93
|
+
optional_fields: [],
|
|
94
|
+
performance_impact: {
|
|
95
|
+
latency: "low",
|
|
96
|
+
resource_usage: "low",
|
|
97
|
+
},
|
|
98
|
+
purpose: "Create new bot-defense-app-infrastructure",
|
|
99
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
100
|
+
side_effects: {
|
|
101
|
+
creates: ["bot-defense-app-infrastructure"],
|
|
102
|
+
},
|
|
103
|
+
},
|
|
104
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bot_defense_app_infrastructures" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
toolName: "f5xc-api-botandthreatdefense-bot-defense-app-infrastructure-delete",
|
|
108
|
+
method: "DELETE",
|
|
109
|
+
path: "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures/{name}",
|
|
110
|
+
operation: "delete",
|
|
111
|
+
domain: "bot_and_threat_defense",
|
|
112
|
+
resource: "bot-defense-app-infrastructure",
|
|
113
|
+
summary: "DELETE Bot Defense App Infrastructure.",
|
|
114
|
+
description: "DELETE the specified bot_defense_app_infrastructure.",
|
|
115
|
+
pathParameters: [
|
|
116
|
+
{
|
|
117
|
+
description: "Name\nName of the configuration object.",
|
|
118
|
+
in: "path",
|
|
119
|
+
name: "name",
|
|
120
|
+
required: true,
|
|
121
|
+
schema: {
|
|
122
|
+
type: "string",
|
|
123
|
+
},
|
|
124
|
+
"x-displayname": "Name",
|
|
125
|
+
"x-ves-example": "Name",
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
129
|
+
in: "path",
|
|
130
|
+
name: "namespace",
|
|
131
|
+
required: true,
|
|
132
|
+
schema: {
|
|
133
|
+
type: "string",
|
|
134
|
+
},
|
|
135
|
+
"x-displayname": "Namespace",
|
|
136
|
+
"x-ves-example": "Ns1",
|
|
137
|
+
},
|
|
138
|
+
],
|
|
139
|
+
queryParameters: [],
|
|
140
|
+
requestBodySchema: {
|
|
141
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureDeleteRequest",
|
|
142
|
+
},
|
|
143
|
+
responseSchema: {},
|
|
144
|
+
requiredParams: ["body", "name", "namespace"],
|
|
145
|
+
operationId: "ves.io.schema.views.bot_defense_app_infrastructure.API.Delete",
|
|
146
|
+
tags: ["Other"],
|
|
147
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
148
|
+
displayName: null,
|
|
149
|
+
dangerLevel: "high",
|
|
150
|
+
sideEffects: {
|
|
151
|
+
deletes: ["bot-defense-app-infrastructure", "contained_resources"],
|
|
152
|
+
},
|
|
153
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
154
|
+
confirmationRequired: true,
|
|
155
|
+
parameterExamples: {
|
|
156
|
+
name: "Name",
|
|
157
|
+
namespace: "Ns1",
|
|
158
|
+
},
|
|
159
|
+
validationRules: {},
|
|
160
|
+
operationMetadata: {
|
|
161
|
+
common_errors: [
|
|
162
|
+
{
|
|
163
|
+
code: 401,
|
|
164
|
+
message: "Authentication required",
|
|
165
|
+
solution: "Provide valid API credentials",
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
code: 403,
|
|
169
|
+
message: "Permission denied",
|
|
170
|
+
solution: "Check access permissions for this operation",
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
code: 404,
|
|
174
|
+
message: "Resource not found",
|
|
175
|
+
solution: "Verify resource name, namespace, and path",
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
code: 409,
|
|
179
|
+
message: "Resource already exists",
|
|
180
|
+
solution: "Use different name or update existing resource",
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
code: 429,
|
|
184
|
+
message: "Rate limit exceeded",
|
|
185
|
+
solution: "Wait before retrying the operation",
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
code: 500,
|
|
189
|
+
message: "Server error",
|
|
190
|
+
solution: "Retry operation or contact support",
|
|
191
|
+
},
|
|
192
|
+
],
|
|
193
|
+
conditions: {
|
|
194
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
195
|
+
prerequisites: ["Active namespace"],
|
|
196
|
+
},
|
|
197
|
+
confirmation_required: true,
|
|
198
|
+
danger_level: "high",
|
|
199
|
+
field_docs: {},
|
|
200
|
+
optional_fields: [],
|
|
201
|
+
performance_impact: {
|
|
202
|
+
latency: "high",
|
|
203
|
+
resource_usage: "moderate",
|
|
204
|
+
},
|
|
205
|
+
purpose: "Delete bot-defense-app-infrastructure",
|
|
206
|
+
required_fields: ["path.name", "path.namespace"],
|
|
207
|
+
side_effects: {
|
|
208
|
+
deletes: ["bot-defense-app-infrastructure", "contained_resources"],
|
|
209
|
+
},
|
|
210
|
+
},
|
|
211
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bot_defense_app_infrastructures" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
toolName: "f5xc-api-botandthreatdefense-bot-defense-app-infrastructure-get",
|
|
215
|
+
method: "GET",
|
|
216
|
+
path: "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures/{name}",
|
|
217
|
+
operation: "get",
|
|
218
|
+
domain: "bot_and_threat_defense",
|
|
219
|
+
resource: "bot-defense-app-infrastructure",
|
|
220
|
+
summary: "Bot Defense App Infrastructure.",
|
|
221
|
+
description: "GET Bot Defense App Infrastructure from a given namespace.",
|
|
222
|
+
pathParameters: [
|
|
223
|
+
{
|
|
224
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
225
|
+
in: "path",
|
|
226
|
+
name: "name",
|
|
227
|
+
required: true,
|
|
228
|
+
schema: {
|
|
229
|
+
type: "string",
|
|
230
|
+
},
|
|
231
|
+
"x-displayname": "Name",
|
|
232
|
+
"x-ves-example": "Name",
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
236
|
+
in: "path",
|
|
237
|
+
name: "namespace",
|
|
238
|
+
required: true,
|
|
239
|
+
schema: {
|
|
240
|
+
type: "string",
|
|
241
|
+
},
|
|
242
|
+
"x-displayname": "Namespace",
|
|
243
|
+
"x-ves-example": "Ns1",
|
|
244
|
+
},
|
|
245
|
+
],
|
|
246
|
+
queryParameters: [
|
|
247
|
+
{
|
|
248
|
+
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 format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
249
|
+
in: "query",
|
|
250
|
+
name: "response_format",
|
|
251
|
+
required: false,
|
|
252
|
+
schema: {
|
|
253
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
254
|
+
enum: [
|
|
255
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
256
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
257
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
258
|
+
"GET_RSP_FORMAT_READ",
|
|
259
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
260
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
261
|
+
],
|
|
262
|
+
type: "string",
|
|
263
|
+
},
|
|
264
|
+
"x-displayname": "Broken Referred Objects.",
|
|
265
|
+
},
|
|
266
|
+
],
|
|
267
|
+
requestBodySchema: null,
|
|
268
|
+
responseSchema: {
|
|
269
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureGetResponse",
|
|
270
|
+
},
|
|
271
|
+
requiredParams: ["name", "namespace"],
|
|
272
|
+
operationId: "ves.io.schema.views.bot_defense_app_infrastructure.API.Get",
|
|
273
|
+
tags: ["Other"],
|
|
274
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
275
|
+
displayName: null,
|
|
276
|
+
dangerLevel: "low",
|
|
277
|
+
sideEffects: null,
|
|
278
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
279
|
+
confirmationRequired: false,
|
|
280
|
+
parameterExamples: {
|
|
281
|
+
name: "Name",
|
|
282
|
+
namespace: "Ns1",
|
|
283
|
+
},
|
|
284
|
+
validationRules: {},
|
|
285
|
+
operationMetadata: {
|
|
286
|
+
common_errors: [
|
|
287
|
+
{
|
|
288
|
+
code: 401,
|
|
289
|
+
message: "Authentication required",
|
|
290
|
+
solution: "Provide valid API credentials",
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
code: 403,
|
|
294
|
+
message: "Permission denied",
|
|
295
|
+
solution: "Check access permissions for this operation",
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
code: 404,
|
|
299
|
+
message: "Resource not found",
|
|
300
|
+
solution: "Verify resource name, namespace, and path",
|
|
301
|
+
},
|
|
302
|
+
{
|
|
303
|
+
code: 409,
|
|
304
|
+
message: "Resource already exists",
|
|
305
|
+
solution: "Use different name or update existing resource",
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
code: 429,
|
|
309
|
+
message: "Rate limit exceeded",
|
|
310
|
+
solution: "Wait before retrying the operation",
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
code: 500,
|
|
314
|
+
message: "Server error",
|
|
315
|
+
solution: "Retry operation or contact support",
|
|
316
|
+
},
|
|
317
|
+
],
|
|
318
|
+
conditions: {
|
|
319
|
+
postconditions: [],
|
|
320
|
+
prerequisites: ["Active namespace"],
|
|
321
|
+
},
|
|
322
|
+
confirmation_required: false,
|
|
323
|
+
danger_level: "low",
|
|
324
|
+
field_docs: {},
|
|
325
|
+
optional_fields: [],
|
|
326
|
+
performance_impact: {
|
|
327
|
+
latency: "low",
|
|
328
|
+
resource_usage: "low",
|
|
329
|
+
},
|
|
330
|
+
purpose: "Retrieve specific bot-defense-app-infrastructure",
|
|
331
|
+
required_fields: ["path.name", "path.namespace"],
|
|
332
|
+
side_effects: {},
|
|
333
|
+
},
|
|
334
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bot_defense_app_infrastructures" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
toolName: "f5xc-api-botandthreatdefense-bot-defense-app-infrastructure-list",
|
|
338
|
+
method: "GET",
|
|
339
|
+
path: "/api/config/namespaces/{namespace}/bot_defense_app_infrastructures",
|
|
340
|
+
operation: "list",
|
|
341
|
+
domain: "bot_and_threat_defense",
|
|
342
|
+
resource: "bot-defense-app-infrastructure",
|
|
343
|
+
summary: "List Bot Defense App Infrastructure.",
|
|
344
|
+
description: "List the set of bot_defense_app_infrastructure in a namespace.",
|
|
345
|
+
pathParameters: [
|
|
346
|
+
{
|
|
347
|
+
description: "Namespace\nNamespace to scope the listing of bot_defense_app_infrastructure.",
|
|
348
|
+
in: "path",
|
|
349
|
+
name: "namespace",
|
|
350
|
+
required: true,
|
|
351
|
+
schema: {
|
|
352
|
+
type: "string",
|
|
353
|
+
},
|
|
354
|
+
"x-displayname": "Namespace",
|
|
355
|
+
"x-ves-example": "Ns1",
|
|
356
|
+
},
|
|
357
|
+
],
|
|
358
|
+
queryParameters: [
|
|
359
|
+
{
|
|
360
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
361
|
+
in: "query",
|
|
362
|
+
name: "label_filter",
|
|
363
|
+
required: false,
|
|
364
|
+
schema: {
|
|
365
|
+
type: "string",
|
|
366
|
+
},
|
|
367
|
+
"x-displayname": "Label Filter.",
|
|
368
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
372
|
+
in: "query",
|
|
373
|
+
name: "report_fields",
|
|
374
|
+
required: false,
|
|
375
|
+
schema: {
|
|
376
|
+
items: {
|
|
377
|
+
type: "string",
|
|
378
|
+
},
|
|
379
|
+
type: "array",
|
|
380
|
+
},
|
|
381
|
+
"x-displayname": "Report Fields.",
|
|
382
|
+
},
|
|
383
|
+
{
|
|
384
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
385
|
+
in: "query",
|
|
386
|
+
name: "report_status_fields",
|
|
387
|
+
required: false,
|
|
388
|
+
schema: {
|
|
389
|
+
items: {
|
|
390
|
+
type: "string",
|
|
391
|
+
},
|
|
392
|
+
type: "array",
|
|
393
|
+
},
|
|
394
|
+
"x-displayname": "Report Status Fields.",
|
|
395
|
+
},
|
|
396
|
+
],
|
|
397
|
+
requestBodySchema: null,
|
|
398
|
+
responseSchema: {
|
|
399
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureListResponse",
|
|
400
|
+
},
|
|
401
|
+
requiredParams: ["namespace"],
|
|
402
|
+
operationId: "ves.io.schema.views.bot_defense_app_infrastructure.API.List",
|
|
403
|
+
tags: ["Other"],
|
|
404
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
405
|
+
displayName: null,
|
|
406
|
+
dangerLevel: "low",
|
|
407
|
+
sideEffects: null,
|
|
408
|
+
requiredFields: ["path.namespace"],
|
|
409
|
+
confirmationRequired: false,
|
|
410
|
+
parameterExamples: {
|
|
411
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
412
|
+
namespace: "Ns1",
|
|
413
|
+
},
|
|
414
|
+
validationRules: {},
|
|
415
|
+
operationMetadata: {
|
|
416
|
+
common_errors: [
|
|
417
|
+
{
|
|
418
|
+
code: 401,
|
|
419
|
+
message: "Authentication required",
|
|
420
|
+
solution: "Provide valid API credentials",
|
|
421
|
+
},
|
|
422
|
+
{
|
|
423
|
+
code: 403,
|
|
424
|
+
message: "Permission denied",
|
|
425
|
+
solution: "Check access permissions for this operation",
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
code: 404,
|
|
429
|
+
message: "Resource not found",
|
|
430
|
+
solution: "Verify resource name, namespace, and path",
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
code: 409,
|
|
434
|
+
message: "Resource already exists",
|
|
435
|
+
solution: "Use different name or update existing resource",
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
code: 429,
|
|
439
|
+
message: "Rate limit exceeded",
|
|
440
|
+
solution: "Wait before retrying the operation",
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
code: 500,
|
|
444
|
+
message: "Server error",
|
|
445
|
+
solution: "Retry operation or contact support",
|
|
446
|
+
},
|
|
447
|
+
],
|
|
448
|
+
conditions: {
|
|
449
|
+
postconditions: [],
|
|
450
|
+
prerequisites: ["Active namespace"],
|
|
451
|
+
},
|
|
452
|
+
confirmation_required: false,
|
|
453
|
+
danger_level: "low",
|
|
454
|
+
field_docs: {},
|
|
455
|
+
optional_fields: [],
|
|
456
|
+
performance_impact: {
|
|
457
|
+
latency: "moderate",
|
|
458
|
+
resource_usage: "moderate",
|
|
459
|
+
},
|
|
460
|
+
purpose: "List all bot-defense-app-infrastructures",
|
|
461
|
+
required_fields: ["path.namespace"],
|
|
462
|
+
side_effects: {},
|
|
463
|
+
},
|
|
464
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bot_defense_app_infrastructures" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
toolName: "f5xc-api-botandthreatdefense-bot-defense-app-infrastructure-update",
|
|
468
|
+
method: "PUT",
|
|
469
|
+
path: "/api/config/namespaces/{metadata.namespace}/bot_defense_app_infrastructures/{metadata.name}",
|
|
470
|
+
operation: "update",
|
|
471
|
+
domain: "bot_and_threat_defense",
|
|
472
|
+
resource: "bot-defense-app-infrastructure",
|
|
473
|
+
summary: "Replace Bot Defense App Infrastructure.",
|
|
474
|
+
description: "Replace a given Bot Defense App Infrastructure in a given namespace.",
|
|
475
|
+
pathParameters: [
|
|
476
|
+
{
|
|
477
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
478
|
+
in: "path",
|
|
479
|
+
name: "metadata.name",
|
|
480
|
+
required: true,
|
|
481
|
+
schema: {
|
|
482
|
+
type: "string",
|
|
483
|
+
},
|
|
484
|
+
"x-displayname": "Name",
|
|
485
|
+
"x-ves-example": "Example-corp-web.",
|
|
486
|
+
},
|
|
487
|
+
{
|
|
488
|
+
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 ""',
|
|
489
|
+
in: "path",
|
|
490
|
+
name: "metadata.namespace",
|
|
491
|
+
required: true,
|
|
492
|
+
schema: {
|
|
493
|
+
type: "string",
|
|
494
|
+
},
|
|
495
|
+
"x-displayname": "Namespace",
|
|
496
|
+
"x-ves-example": "Staging",
|
|
497
|
+
},
|
|
498
|
+
],
|
|
499
|
+
queryParameters: [],
|
|
500
|
+
requestBodySchema: {
|
|
501
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureReplaceRequest",
|
|
502
|
+
},
|
|
503
|
+
responseSchema: {
|
|
504
|
+
$ref: "#/components/schemas/bot_defense_app_infrastructureReplaceResponse",
|
|
505
|
+
},
|
|
506
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
507
|
+
operationId: "ves.io.schema.views.bot_defense_app_infrastructure.API.Replace",
|
|
508
|
+
tags: ["Other"],
|
|
509
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
510
|
+
displayName: null,
|
|
511
|
+
dangerLevel: "medium",
|
|
512
|
+
sideEffects: {
|
|
513
|
+
modifies: ["bot-defense-app-infrastructure"],
|
|
514
|
+
},
|
|
515
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
516
|
+
confirmationRequired: false,
|
|
517
|
+
parameterExamples: {
|
|
518
|
+
"metadata.name": "Example-corp-web.",
|
|
519
|
+
"metadata.namespace": "Staging",
|
|
520
|
+
},
|
|
521
|
+
validationRules: {},
|
|
522
|
+
operationMetadata: {
|
|
523
|
+
common_errors: [
|
|
524
|
+
{
|
|
525
|
+
code: 401,
|
|
526
|
+
message: "Authentication required",
|
|
527
|
+
solution: "Provide valid API credentials",
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
code: 403,
|
|
531
|
+
message: "Permission denied",
|
|
532
|
+
solution: "Check access permissions for this operation",
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
code: 404,
|
|
536
|
+
message: "Resource not found",
|
|
537
|
+
solution: "Verify resource name, namespace, and path",
|
|
538
|
+
},
|
|
539
|
+
{
|
|
540
|
+
code: 409,
|
|
541
|
+
message: "Resource already exists",
|
|
542
|
+
solution: "Use different name or update existing resource",
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
code: 429,
|
|
546
|
+
message: "Rate limit exceeded",
|
|
547
|
+
solution: "Wait before retrying the operation",
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
code: 500,
|
|
551
|
+
message: "Server error",
|
|
552
|
+
solution: "Retry operation or contact support",
|
|
553
|
+
},
|
|
554
|
+
],
|
|
555
|
+
conditions: {
|
|
556
|
+
postconditions: ["Resource updated with new values"],
|
|
557
|
+
prerequisites: ["Active namespace"],
|
|
558
|
+
},
|
|
559
|
+
confirmation_required: false,
|
|
560
|
+
danger_level: "medium",
|
|
561
|
+
field_docs: {},
|
|
562
|
+
optional_fields: [],
|
|
563
|
+
performance_impact: {
|
|
564
|
+
latency: "low",
|
|
565
|
+
resource_usage: "low",
|
|
566
|
+
},
|
|
567
|
+
purpose: "Replace existing bot-defense-app-infrastructure",
|
|
568
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
569
|
+
side_effects: {
|
|
570
|
+
modifies: ["bot-defense-app-infrastructure"],
|
|
571
|
+
},
|
|
572
|
+
},
|
|
573
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/bot_defense_app_infrastructures" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
toolName: "f5xc-api-botandthreatdefense-preauth-create",
|
|
577
|
+
method: "POST",
|
|
578
|
+
path: "/api/tpm/tpm/preauth",
|
|
579
|
+
operation: "create",
|
|
580
|
+
domain: "bot_and_threat_defense",
|
|
581
|
+
resource: "preauth",
|
|
582
|
+
summary: "Preauth",
|
|
583
|
+
description: "Pre-flight auth checks before calling the Provision API.",
|
|
584
|
+
pathParameters: [],
|
|
585
|
+
queryParameters: [],
|
|
586
|
+
requestBodySchema: {
|
|
587
|
+
$ref: "#/components/schemas/tpm_provisionPreauthRequest",
|
|
588
|
+
},
|
|
589
|
+
responseSchema: {
|
|
590
|
+
$ref: "#/components/schemas/tpm_provisionPreauthResponse",
|
|
591
|
+
},
|
|
592
|
+
requiredParams: ["body"],
|
|
593
|
+
operationId: "ves.io.schema.tpm_provision.CustomAPI.Preauth",
|
|
594
|
+
tags: ["Other"],
|
|
595
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
596
|
+
displayName: null,
|
|
597
|
+
dangerLevel: "medium",
|
|
598
|
+
sideEffects: {
|
|
599
|
+
creates: ["preauth"],
|
|
600
|
+
},
|
|
601
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
602
|
+
confirmationRequired: false,
|
|
603
|
+
parameterExamples: {},
|
|
604
|
+
validationRules: {},
|
|
605
|
+
operationMetadata: {
|
|
606
|
+
common_errors: [
|
|
607
|
+
{
|
|
608
|
+
code: 401,
|
|
609
|
+
message: "Authentication required",
|
|
610
|
+
solution: "Provide valid API credentials",
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
code: 403,
|
|
614
|
+
message: "Permission denied",
|
|
615
|
+
solution: "Check access permissions for this operation",
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
code: 404,
|
|
619
|
+
message: "Resource not found",
|
|
620
|
+
solution: "Verify resource name, namespace, and path",
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
code: 409,
|
|
624
|
+
message: "Resource already exists",
|
|
625
|
+
solution: "Use different name or update existing resource",
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
code: 429,
|
|
629
|
+
message: "Rate limit exceeded",
|
|
630
|
+
solution: "Wait before retrying the operation",
|
|
631
|
+
},
|
|
632
|
+
{
|
|
633
|
+
code: 500,
|
|
634
|
+
message: "Server error",
|
|
635
|
+
solution: "Retry operation or contact support",
|
|
636
|
+
},
|
|
637
|
+
],
|
|
638
|
+
conditions: {
|
|
639
|
+
postconditions: ["Preauth resource created", "Resource assigned unique identifier"],
|
|
640
|
+
prerequisites: [],
|
|
641
|
+
},
|
|
642
|
+
confirmation_required: false,
|
|
643
|
+
danger_level: "medium",
|
|
644
|
+
field_docs: {},
|
|
645
|
+
optional_fields: [],
|
|
646
|
+
performance_impact: {
|
|
647
|
+
latency: "low",
|
|
648
|
+
resource_usage: "low",
|
|
649
|
+
},
|
|
650
|
+
purpose: "Create new preauth",
|
|
651
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
652
|
+
side_effects: {
|
|
653
|
+
creates: ["preauth"],
|
|
654
|
+
},
|
|
655
|
+
},
|
|
656
|
+
curlExample: null,
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
toolName: "f5xc-api-botandthreatdefense-provision-create",
|
|
660
|
+
method: "POST",
|
|
661
|
+
path: "/api/tpm/tpm/provision",
|
|
662
|
+
operation: "create",
|
|
663
|
+
domain: "bot_and_threat_defense",
|
|
664
|
+
resource: "provision",
|
|
665
|
+
summary: "Provision",
|
|
666
|
+
description: "Provision CustomAPI.",
|
|
667
|
+
pathParameters: [],
|
|
668
|
+
queryParameters: [],
|
|
669
|
+
requestBodySchema: {
|
|
670
|
+
$ref: "#/components/schemas/tpm_provisionProvisionRequest",
|
|
671
|
+
},
|
|
672
|
+
responseSchema: {
|
|
673
|
+
$ref: "#/components/schemas/tpm_provisionProvisionResponse",
|
|
674
|
+
},
|
|
675
|
+
requiredParams: ["body"],
|
|
676
|
+
operationId: "ves.io.schema.tpm_provision.CustomAPI.Provision",
|
|
677
|
+
tags: ["Other"],
|
|
678
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
679
|
+
displayName: null,
|
|
680
|
+
dangerLevel: "medium",
|
|
681
|
+
sideEffects: {
|
|
682
|
+
creates: ["provision"],
|
|
683
|
+
},
|
|
684
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
685
|
+
confirmationRequired: false,
|
|
686
|
+
parameterExamples: {},
|
|
687
|
+
validationRules: {},
|
|
688
|
+
operationMetadata: {
|
|
689
|
+
common_errors: [
|
|
690
|
+
{
|
|
691
|
+
code: 401,
|
|
692
|
+
message: "Authentication required",
|
|
693
|
+
solution: "Provide valid API credentials",
|
|
694
|
+
},
|
|
695
|
+
{
|
|
696
|
+
code: 403,
|
|
697
|
+
message: "Permission denied",
|
|
698
|
+
solution: "Check access permissions for this operation",
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
code: 404,
|
|
702
|
+
message: "Resource not found",
|
|
703
|
+
solution: "Verify resource name, namespace, and path",
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
code: 409,
|
|
707
|
+
message: "Resource already exists",
|
|
708
|
+
solution: "Use different name or update existing resource",
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
code: 429,
|
|
712
|
+
message: "Rate limit exceeded",
|
|
713
|
+
solution: "Wait before retrying the operation",
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
code: 500,
|
|
717
|
+
message: "Server error",
|
|
718
|
+
solution: "Retry operation or contact support",
|
|
719
|
+
},
|
|
720
|
+
],
|
|
721
|
+
conditions: {
|
|
722
|
+
postconditions: ["Provision resource created", "Resource assigned unique identifier"],
|
|
723
|
+
prerequisites: [],
|
|
724
|
+
},
|
|
725
|
+
confirmation_required: false,
|
|
726
|
+
danger_level: "medium",
|
|
727
|
+
field_docs: {},
|
|
728
|
+
optional_fields: [],
|
|
729
|
+
performance_impact: {
|
|
730
|
+
latency: "low",
|
|
731
|
+
resource_usage: "low",
|
|
732
|
+
},
|
|
733
|
+
purpose: "Create new provision",
|
|
734
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
735
|
+
side_effects: {
|
|
736
|
+
creates: ["provision"],
|
|
737
|
+
},
|
|
738
|
+
},
|
|
739
|
+
curlExample: null,
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
toolName: "f5xc-api-botandthreatdefense-shape-bot-defense-instance-get",
|
|
743
|
+
method: "GET",
|
|
744
|
+
path: "/api/config/namespaces/{namespace}/shape_bot_defense_instances/{name}",
|
|
745
|
+
operation: "get",
|
|
746
|
+
domain: "bot_and_threat_defense",
|
|
747
|
+
resource: "shape-bot-defense-instance",
|
|
748
|
+
summary: "GET Virtual Host.",
|
|
749
|
+
description: "GET virtual host from a given namespace.",
|
|
750
|
+
pathParameters: [
|
|
751
|
+
{
|
|
752
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
753
|
+
in: "path",
|
|
754
|
+
name: "name",
|
|
755
|
+
required: true,
|
|
756
|
+
schema: {
|
|
757
|
+
type: "string",
|
|
758
|
+
},
|
|
759
|
+
"x-displayname": "Name",
|
|
760
|
+
"x-ves-example": "Name",
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
764
|
+
in: "path",
|
|
765
|
+
name: "namespace",
|
|
766
|
+
required: true,
|
|
767
|
+
schema: {
|
|
768
|
+
type: "string",
|
|
769
|
+
},
|
|
770
|
+
"x-displayname": "Namespace",
|
|
771
|
+
"x-ves-example": "Ns1",
|
|
772
|
+
},
|
|
773
|
+
],
|
|
774
|
+
queryParameters: [
|
|
775
|
+
{
|
|
776
|
+
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 format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
777
|
+
in: "query",
|
|
778
|
+
name: "response_format",
|
|
779
|
+
required: false,
|
|
780
|
+
schema: {
|
|
781
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
782
|
+
enum: [
|
|
783
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
784
|
+
"GET_RSP_FORMAT_READ",
|
|
785
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
786
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
787
|
+
],
|
|
788
|
+
type: "string",
|
|
789
|
+
},
|
|
790
|
+
"x-displayname": "Broken Referred Objects.",
|
|
791
|
+
},
|
|
792
|
+
],
|
|
793
|
+
requestBodySchema: null,
|
|
794
|
+
responseSchema: {
|
|
795
|
+
$ref: "#/components/schemas/shape_bot_defense_instanceGetResponse",
|
|
796
|
+
},
|
|
797
|
+
requiredParams: ["name", "namespace"],
|
|
798
|
+
operationId: "ves.io.schema.shape_bot_defense_instance.API.Get",
|
|
799
|
+
tags: ["Other"],
|
|
800
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
801
|
+
displayName: null,
|
|
802
|
+
dangerLevel: "low",
|
|
803
|
+
sideEffects: null,
|
|
804
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
805
|
+
confirmationRequired: false,
|
|
806
|
+
parameterExamples: {
|
|
807
|
+
name: "Name",
|
|
808
|
+
namespace: "Ns1",
|
|
809
|
+
},
|
|
810
|
+
validationRules: {},
|
|
811
|
+
operationMetadata: {
|
|
812
|
+
common_errors: [
|
|
813
|
+
{
|
|
814
|
+
code: 401,
|
|
815
|
+
message: "Authentication required",
|
|
816
|
+
solution: "Provide valid API credentials",
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
code: 403,
|
|
820
|
+
message: "Permission denied",
|
|
821
|
+
solution: "Check access permissions for this operation",
|
|
822
|
+
},
|
|
823
|
+
{
|
|
824
|
+
code: 404,
|
|
825
|
+
message: "Resource not found",
|
|
826
|
+
solution: "Verify resource name, namespace, and path",
|
|
827
|
+
},
|
|
828
|
+
{
|
|
829
|
+
code: 409,
|
|
830
|
+
message: "Resource already exists",
|
|
831
|
+
solution: "Use different name or update existing resource",
|
|
832
|
+
},
|
|
833
|
+
{
|
|
834
|
+
code: 429,
|
|
835
|
+
message: "Rate limit exceeded",
|
|
836
|
+
solution: "Wait before retrying the operation",
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
code: 500,
|
|
840
|
+
message: "Server error",
|
|
841
|
+
solution: "Retry operation or contact support",
|
|
842
|
+
},
|
|
843
|
+
],
|
|
844
|
+
conditions: {
|
|
845
|
+
postconditions: [],
|
|
846
|
+
prerequisites: ["Active namespace"],
|
|
847
|
+
},
|
|
848
|
+
confirmation_required: false,
|
|
849
|
+
danger_level: "low",
|
|
850
|
+
field_docs: {},
|
|
851
|
+
optional_fields: [],
|
|
852
|
+
performance_impact: {
|
|
853
|
+
latency: "low",
|
|
854
|
+
resource_usage: "low",
|
|
855
|
+
},
|
|
856
|
+
purpose: "Retrieve specific shape-bot-defense-instance",
|
|
857
|
+
required_fields: ["path.name", "path.namespace"],
|
|
858
|
+
side_effects: {},
|
|
859
|
+
},
|
|
860
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/shape_bot_defense_instances" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
861
|
+
},
|
|
862
|
+
{
|
|
863
|
+
toolName: "f5xc-api-botandthreatdefense-shape-bot-defense-instance-list",
|
|
864
|
+
method: "GET",
|
|
865
|
+
path: "/api/config/namespaces/{namespace}/shape_bot_defense_instances",
|
|
866
|
+
operation: "list",
|
|
867
|
+
domain: "bot_and_threat_defense",
|
|
868
|
+
resource: "shape-bot-defense-instance",
|
|
869
|
+
summary: "List Shape Bot Defense Instance.",
|
|
870
|
+
description: "List the set of shape_bot_defense_instance in a namespace.",
|
|
871
|
+
pathParameters: [
|
|
872
|
+
{
|
|
873
|
+
description: "Namespace\nNamespace to scope the listing of shape_bot_defense_instance.",
|
|
874
|
+
in: "path",
|
|
875
|
+
name: "namespace",
|
|
876
|
+
required: true,
|
|
877
|
+
schema: {
|
|
878
|
+
type: "string",
|
|
879
|
+
},
|
|
880
|
+
"x-displayname": "Namespace",
|
|
881
|
+
"x-ves-example": "Ns1",
|
|
882
|
+
},
|
|
883
|
+
],
|
|
884
|
+
queryParameters: [
|
|
885
|
+
{
|
|
886
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
887
|
+
in: "query",
|
|
888
|
+
name: "label_filter",
|
|
889
|
+
required: false,
|
|
890
|
+
schema: {
|
|
891
|
+
type: "string",
|
|
892
|
+
},
|
|
893
|
+
"x-displayname": "Label Filter.",
|
|
894
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
895
|
+
},
|
|
896
|
+
{
|
|
897
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
898
|
+
in: "query",
|
|
899
|
+
name: "report_fields",
|
|
900
|
+
required: false,
|
|
901
|
+
schema: {
|
|
902
|
+
items: {
|
|
903
|
+
type: "string",
|
|
904
|
+
},
|
|
905
|
+
type: "array",
|
|
906
|
+
},
|
|
907
|
+
"x-displayname": "Report Fields.",
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
911
|
+
in: "query",
|
|
912
|
+
name: "report_status_fields",
|
|
913
|
+
required: false,
|
|
914
|
+
schema: {
|
|
915
|
+
items: {
|
|
916
|
+
type: "string",
|
|
917
|
+
},
|
|
918
|
+
type: "array",
|
|
919
|
+
},
|
|
920
|
+
"x-displayname": "Report Status Fields.",
|
|
921
|
+
},
|
|
922
|
+
],
|
|
923
|
+
requestBodySchema: null,
|
|
924
|
+
responseSchema: {
|
|
925
|
+
$ref: "#/components/schemas/shape_bot_defense_instanceListResponse",
|
|
926
|
+
},
|
|
927
|
+
requiredParams: ["namespace"],
|
|
928
|
+
operationId: "ves.io.schema.shape_bot_defense_instance.API.List",
|
|
929
|
+
tags: ["Other"],
|
|
930
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
931
|
+
displayName: null,
|
|
932
|
+
dangerLevel: "low",
|
|
933
|
+
sideEffects: null,
|
|
934
|
+
requiredFields: ["path.namespace"],
|
|
935
|
+
confirmationRequired: false,
|
|
936
|
+
parameterExamples: {
|
|
937
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
938
|
+
namespace: "Ns1",
|
|
939
|
+
},
|
|
940
|
+
validationRules: {},
|
|
941
|
+
operationMetadata: {
|
|
942
|
+
common_errors: [
|
|
943
|
+
{
|
|
944
|
+
code: 401,
|
|
945
|
+
message: "Authentication required",
|
|
946
|
+
solution: "Provide valid API credentials",
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
code: 403,
|
|
950
|
+
message: "Permission denied",
|
|
951
|
+
solution: "Check access permissions for this operation",
|
|
952
|
+
},
|
|
953
|
+
{
|
|
954
|
+
code: 404,
|
|
955
|
+
message: "Resource not found",
|
|
956
|
+
solution: "Verify resource name, namespace, and path",
|
|
957
|
+
},
|
|
958
|
+
{
|
|
959
|
+
code: 409,
|
|
960
|
+
message: "Resource already exists",
|
|
961
|
+
solution: "Use different name or update existing resource",
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
code: 429,
|
|
965
|
+
message: "Rate limit exceeded",
|
|
966
|
+
solution: "Wait before retrying the operation",
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
code: 500,
|
|
970
|
+
message: "Server error",
|
|
971
|
+
solution: "Retry operation or contact support",
|
|
972
|
+
},
|
|
973
|
+
],
|
|
974
|
+
conditions: {
|
|
975
|
+
postconditions: [],
|
|
976
|
+
prerequisites: ["Active namespace"],
|
|
977
|
+
},
|
|
978
|
+
confirmation_required: false,
|
|
979
|
+
danger_level: "low",
|
|
980
|
+
field_docs: {},
|
|
981
|
+
optional_fields: [],
|
|
982
|
+
performance_impact: {
|
|
983
|
+
latency: "moderate",
|
|
984
|
+
resource_usage: "moderate",
|
|
985
|
+
},
|
|
986
|
+
purpose: "List all shape-bot-defense-instances",
|
|
987
|
+
required_fields: ["path.namespace"],
|
|
988
|
+
side_effects: {},
|
|
989
|
+
},
|
|
990
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/shape_bot_defense_instances" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-api-key-create",
|
|
994
|
+
method: "POST",
|
|
995
|
+
path: "/api/tpm/namespaces/{metadata.namespace}/tpm_api_keys",
|
|
996
|
+
operation: "create",
|
|
997
|
+
domain: "bot_and_threat_defense",
|
|
998
|
+
resource: "tpm-api-key",
|
|
999
|
+
summary: "Create TPM API Key.",
|
|
1000
|
+
description: "APIKey object when successfully created returns actual APIKey bytes which is used by the users to call in to\nTPM provisioning API.",
|
|
1001
|
+
pathParameters: [
|
|
1002
|
+
{
|
|
1003
|
+
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 ""',
|
|
1004
|
+
in: "path",
|
|
1005
|
+
name: "metadata.namespace",
|
|
1006
|
+
required: true,
|
|
1007
|
+
schema: {
|
|
1008
|
+
type: "string",
|
|
1009
|
+
},
|
|
1010
|
+
"x-displayname": "Namespace",
|
|
1011
|
+
"x-ves-example": "Staging",
|
|
1012
|
+
},
|
|
1013
|
+
],
|
|
1014
|
+
queryParameters: [],
|
|
1015
|
+
requestBodySchema: {
|
|
1016
|
+
$ref: "#/components/schemas/tpm_api_keyCreateRequest",
|
|
1017
|
+
},
|
|
1018
|
+
responseSchema: {
|
|
1019
|
+
$ref: "#/components/schemas/tpm_api_keyCreateResponse",
|
|
1020
|
+
},
|
|
1021
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1022
|
+
operationId: "ves.io.schema.tpm_api_key.API.Create",
|
|
1023
|
+
tags: ["Other"],
|
|
1024
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1025
|
+
displayName: null,
|
|
1026
|
+
dangerLevel: "medium",
|
|
1027
|
+
sideEffects: {
|
|
1028
|
+
creates: ["tpm-api-key"],
|
|
1029
|
+
},
|
|
1030
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1031
|
+
confirmationRequired: false,
|
|
1032
|
+
parameterExamples: {
|
|
1033
|
+
"metadata.namespace": "Staging",
|
|
1034
|
+
},
|
|
1035
|
+
validationRules: {},
|
|
1036
|
+
operationMetadata: {
|
|
1037
|
+
common_errors: [
|
|
1038
|
+
{
|
|
1039
|
+
code: 401,
|
|
1040
|
+
message: "Authentication required",
|
|
1041
|
+
solution: "Provide valid API credentials",
|
|
1042
|
+
},
|
|
1043
|
+
{
|
|
1044
|
+
code: 403,
|
|
1045
|
+
message: "Permission denied",
|
|
1046
|
+
solution: "Check access permissions for this operation",
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
code: 404,
|
|
1050
|
+
message: "Resource not found",
|
|
1051
|
+
solution: "Verify resource name, namespace, and path",
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
code: 409,
|
|
1055
|
+
message: "Resource already exists",
|
|
1056
|
+
solution: "Use different name or update existing resource",
|
|
1057
|
+
},
|
|
1058
|
+
{
|
|
1059
|
+
code: 429,
|
|
1060
|
+
message: "Rate limit exceeded",
|
|
1061
|
+
solution: "Wait before retrying the operation",
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
code: 500,
|
|
1065
|
+
message: "Server error",
|
|
1066
|
+
solution: "Retry operation or contact support",
|
|
1067
|
+
},
|
|
1068
|
+
],
|
|
1069
|
+
conditions: {
|
|
1070
|
+
postconditions: ["Tpm-api-key resource created", "Resource assigned unique identifier"],
|
|
1071
|
+
prerequisites: ["Active namespace"],
|
|
1072
|
+
},
|
|
1073
|
+
confirmation_required: false,
|
|
1074
|
+
danger_level: "medium",
|
|
1075
|
+
field_docs: {},
|
|
1076
|
+
optional_fields: [],
|
|
1077
|
+
performance_impact: {
|
|
1078
|
+
latency: "low",
|
|
1079
|
+
resource_usage: "low",
|
|
1080
|
+
},
|
|
1081
|
+
purpose: "Create new tpm-api-key",
|
|
1082
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1083
|
+
side_effects: {
|
|
1084
|
+
creates: ["tpm-api-key"],
|
|
1085
|
+
},
|
|
1086
|
+
},
|
|
1087
|
+
curlExample: null,
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-api-key-get",
|
|
1091
|
+
method: "GET",
|
|
1092
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_api_keys/{name}",
|
|
1093
|
+
operation: "get",
|
|
1094
|
+
domain: "bot_and_threat_defense",
|
|
1095
|
+
resource: "tpm-api-key",
|
|
1096
|
+
summary: "GET TPM API Key.",
|
|
1097
|
+
description: "Retrieve an APIKey object.",
|
|
1098
|
+
pathParameters: [
|
|
1099
|
+
{
|
|
1100
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1101
|
+
in: "path",
|
|
1102
|
+
name: "name",
|
|
1103
|
+
required: true,
|
|
1104
|
+
schema: {
|
|
1105
|
+
type: "string",
|
|
1106
|
+
},
|
|
1107
|
+
"x-displayname": "Name",
|
|
1108
|
+
"x-ves-example": "Name",
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1112
|
+
in: "path",
|
|
1113
|
+
name: "namespace",
|
|
1114
|
+
required: true,
|
|
1115
|
+
schema: {
|
|
1116
|
+
type: "string",
|
|
1117
|
+
},
|
|
1118
|
+
"x-displayname": "Namespace",
|
|
1119
|
+
"x-ves-example": "Ns1",
|
|
1120
|
+
},
|
|
1121
|
+
],
|
|
1122
|
+
queryParameters: [
|
|
1123
|
+
{
|
|
1124
|
+
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.",
|
|
1125
|
+
in: "query",
|
|
1126
|
+
name: "response_format",
|
|
1127
|
+
required: false,
|
|
1128
|
+
schema: {
|
|
1129
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1130
|
+
enum: [
|
|
1131
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1132
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1133
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1134
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1135
|
+
"GET_RSP_FORMAT_READ",
|
|
1136
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1137
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1138
|
+
],
|
|
1139
|
+
type: "string",
|
|
1140
|
+
},
|
|
1141
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1142
|
+
},
|
|
1143
|
+
],
|
|
1144
|
+
requestBodySchema: null,
|
|
1145
|
+
responseSchema: {
|
|
1146
|
+
$ref: "#/components/schemas/tpm_api_keyGetResponse",
|
|
1147
|
+
},
|
|
1148
|
+
requiredParams: ["name", "namespace"],
|
|
1149
|
+
operationId: "ves.io.schema.tpm_api_key.API.Get",
|
|
1150
|
+
tags: ["Other"],
|
|
1151
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1152
|
+
displayName: null,
|
|
1153
|
+
dangerLevel: "low",
|
|
1154
|
+
sideEffects: null,
|
|
1155
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1156
|
+
confirmationRequired: false,
|
|
1157
|
+
parameterExamples: {
|
|
1158
|
+
name: "Name",
|
|
1159
|
+
namespace: "Ns1",
|
|
1160
|
+
},
|
|
1161
|
+
validationRules: {},
|
|
1162
|
+
operationMetadata: {
|
|
1163
|
+
common_errors: [
|
|
1164
|
+
{
|
|
1165
|
+
code: 401,
|
|
1166
|
+
message: "Authentication required",
|
|
1167
|
+
solution: "Provide valid API credentials",
|
|
1168
|
+
},
|
|
1169
|
+
{
|
|
1170
|
+
code: 403,
|
|
1171
|
+
message: "Permission denied",
|
|
1172
|
+
solution: "Check access permissions for this operation",
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
code: 404,
|
|
1176
|
+
message: "Resource not found",
|
|
1177
|
+
solution: "Verify resource name, namespace, and path",
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
code: 409,
|
|
1181
|
+
message: "Resource already exists",
|
|
1182
|
+
solution: "Use different name or update existing resource",
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
code: 429,
|
|
1186
|
+
message: "Rate limit exceeded",
|
|
1187
|
+
solution: "Wait before retrying the operation",
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
code: 500,
|
|
1191
|
+
message: "Server error",
|
|
1192
|
+
solution: "Retry operation or contact support",
|
|
1193
|
+
},
|
|
1194
|
+
],
|
|
1195
|
+
conditions: {
|
|
1196
|
+
postconditions: [],
|
|
1197
|
+
prerequisites: ["Active namespace"],
|
|
1198
|
+
},
|
|
1199
|
+
confirmation_required: false,
|
|
1200
|
+
danger_level: "low",
|
|
1201
|
+
field_docs: {},
|
|
1202
|
+
optional_fields: [],
|
|
1203
|
+
performance_impact: {
|
|
1204
|
+
latency: "low",
|
|
1205
|
+
resource_usage: "low",
|
|
1206
|
+
},
|
|
1207
|
+
purpose: "Retrieve specific tpm-api-key",
|
|
1208
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1209
|
+
side_effects: {},
|
|
1210
|
+
},
|
|
1211
|
+
curlExample: null,
|
|
1212
|
+
},
|
|
1213
|
+
{
|
|
1214
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-api-key-list",
|
|
1215
|
+
method: "GET",
|
|
1216
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_api_keys",
|
|
1217
|
+
operation: "list",
|
|
1218
|
+
domain: "bot_and_threat_defense",
|
|
1219
|
+
resource: "tpm-api-key",
|
|
1220
|
+
summary: "List TPM API Key.",
|
|
1221
|
+
description: "List the set of tpm_api_key in a namespace.",
|
|
1222
|
+
pathParameters: [
|
|
1223
|
+
{
|
|
1224
|
+
description: "Namespace\nNamespace to scope the listing of tpm_api_key.",
|
|
1225
|
+
in: "path",
|
|
1226
|
+
name: "namespace",
|
|
1227
|
+
required: true,
|
|
1228
|
+
schema: {
|
|
1229
|
+
type: "string",
|
|
1230
|
+
},
|
|
1231
|
+
"x-displayname": "Namespace",
|
|
1232
|
+
"x-ves-example": "Ns1",
|
|
1233
|
+
},
|
|
1234
|
+
],
|
|
1235
|
+
queryParameters: [
|
|
1236
|
+
{
|
|
1237
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1238
|
+
in: "query",
|
|
1239
|
+
name: "label_filter",
|
|
1240
|
+
required: false,
|
|
1241
|
+
schema: {
|
|
1242
|
+
type: "string",
|
|
1243
|
+
},
|
|
1244
|
+
"x-displayname": "Label Filter.",
|
|
1245
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1246
|
+
},
|
|
1247
|
+
{
|
|
1248
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1249
|
+
in: "query",
|
|
1250
|
+
name: "report_fields",
|
|
1251
|
+
required: false,
|
|
1252
|
+
schema: {
|
|
1253
|
+
items: {
|
|
1254
|
+
type: "string",
|
|
1255
|
+
},
|
|
1256
|
+
type: "array",
|
|
1257
|
+
},
|
|
1258
|
+
"x-displayname": "Report Fields.",
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1262
|
+
in: "query",
|
|
1263
|
+
name: "report_status_fields",
|
|
1264
|
+
required: false,
|
|
1265
|
+
schema: {
|
|
1266
|
+
items: {
|
|
1267
|
+
type: "string",
|
|
1268
|
+
},
|
|
1269
|
+
type: "array",
|
|
1270
|
+
},
|
|
1271
|
+
"x-displayname": "Report Status Fields.",
|
|
1272
|
+
},
|
|
1273
|
+
],
|
|
1274
|
+
requestBodySchema: null,
|
|
1275
|
+
responseSchema: {
|
|
1276
|
+
$ref: "#/components/schemas/tpm_api_keyListResponse",
|
|
1277
|
+
},
|
|
1278
|
+
requiredParams: ["namespace"],
|
|
1279
|
+
operationId: "ves.io.schema.tpm_api_key.API.List",
|
|
1280
|
+
tags: ["Other"],
|
|
1281
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1282
|
+
displayName: null,
|
|
1283
|
+
dangerLevel: "low",
|
|
1284
|
+
sideEffects: null,
|
|
1285
|
+
requiredFields: ["path.namespace"],
|
|
1286
|
+
confirmationRequired: false,
|
|
1287
|
+
parameterExamples: {
|
|
1288
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1289
|
+
namespace: "Ns1",
|
|
1290
|
+
},
|
|
1291
|
+
validationRules: {},
|
|
1292
|
+
operationMetadata: {
|
|
1293
|
+
common_errors: [
|
|
1294
|
+
{
|
|
1295
|
+
code: 401,
|
|
1296
|
+
message: "Authentication required",
|
|
1297
|
+
solution: "Provide valid API credentials",
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
code: 403,
|
|
1301
|
+
message: "Permission denied",
|
|
1302
|
+
solution: "Check access permissions for this operation",
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
code: 404,
|
|
1306
|
+
message: "Resource not found",
|
|
1307
|
+
solution: "Verify resource name, namespace, and path",
|
|
1308
|
+
},
|
|
1309
|
+
{
|
|
1310
|
+
code: 409,
|
|
1311
|
+
message: "Resource already exists",
|
|
1312
|
+
solution: "Use different name or update existing resource",
|
|
1313
|
+
},
|
|
1314
|
+
{
|
|
1315
|
+
code: 429,
|
|
1316
|
+
message: "Rate limit exceeded",
|
|
1317
|
+
solution: "Wait before retrying the operation",
|
|
1318
|
+
},
|
|
1319
|
+
{
|
|
1320
|
+
code: 500,
|
|
1321
|
+
message: "Server error",
|
|
1322
|
+
solution: "Retry operation or contact support",
|
|
1323
|
+
},
|
|
1324
|
+
],
|
|
1325
|
+
conditions: {
|
|
1326
|
+
postconditions: [],
|
|
1327
|
+
prerequisites: ["Active namespace"],
|
|
1328
|
+
},
|
|
1329
|
+
confirmation_required: false,
|
|
1330
|
+
danger_level: "low",
|
|
1331
|
+
field_docs: {},
|
|
1332
|
+
optional_fields: [],
|
|
1333
|
+
performance_impact: {
|
|
1334
|
+
latency: "moderate",
|
|
1335
|
+
resource_usage: "moderate",
|
|
1336
|
+
},
|
|
1337
|
+
purpose: "List all tpm-api-keys",
|
|
1338
|
+
required_fields: ["path.namespace"],
|
|
1339
|
+
side_effects: {},
|
|
1340
|
+
},
|
|
1341
|
+
curlExample: null,
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-api-key-update",
|
|
1345
|
+
method: "PUT",
|
|
1346
|
+
path: "/api/tpm/namespaces/{metadata.namespace}/tpm_api_keys/{metadata.name}",
|
|
1347
|
+
operation: "update",
|
|
1348
|
+
domain: "bot_and_threat_defense",
|
|
1349
|
+
resource: "tpm-api-key",
|
|
1350
|
+
summary: "Replace TPM API Key.",
|
|
1351
|
+
description: "Replace a APIKey object's revocation or enable/disable status. A revoked APIKey is not considered disabled.\nCertificates minted using disabled APIKeys are rejected during system bring-up/verification stage,\nwhereas certificates minted using revoked APIKeys are only rejected if they were minted after revocation date.",
|
|
1352
|
+
pathParameters: [
|
|
1353
|
+
{
|
|
1354
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1355
|
+
in: "path",
|
|
1356
|
+
name: "metadata.name",
|
|
1357
|
+
required: true,
|
|
1358
|
+
schema: {
|
|
1359
|
+
type: "string",
|
|
1360
|
+
},
|
|
1361
|
+
"x-displayname": "Name",
|
|
1362
|
+
"x-ves-example": "Example-corp-web.",
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
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 ""',
|
|
1366
|
+
in: "path",
|
|
1367
|
+
name: "metadata.namespace",
|
|
1368
|
+
required: true,
|
|
1369
|
+
schema: {
|
|
1370
|
+
type: "string",
|
|
1371
|
+
},
|
|
1372
|
+
"x-displayname": "Namespace",
|
|
1373
|
+
"x-ves-example": "Staging",
|
|
1374
|
+
},
|
|
1375
|
+
],
|
|
1376
|
+
queryParameters: [],
|
|
1377
|
+
requestBodySchema: {
|
|
1378
|
+
$ref: "#/components/schemas/tpm_api_keyReplaceRequest",
|
|
1379
|
+
},
|
|
1380
|
+
responseSchema: {
|
|
1381
|
+
$ref: "#/components/schemas/tpm_api_keyReplaceResponse",
|
|
1382
|
+
},
|
|
1383
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1384
|
+
operationId: "ves.io.schema.tpm_api_key.API.Replace",
|
|
1385
|
+
tags: ["Other"],
|
|
1386
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1387
|
+
displayName: null,
|
|
1388
|
+
dangerLevel: "medium",
|
|
1389
|
+
sideEffects: {
|
|
1390
|
+
modifies: ["tpm-api-key"],
|
|
1391
|
+
},
|
|
1392
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1393
|
+
confirmationRequired: false,
|
|
1394
|
+
parameterExamples: {
|
|
1395
|
+
"metadata.name": "Example-corp-web.",
|
|
1396
|
+
"metadata.namespace": "Staging",
|
|
1397
|
+
},
|
|
1398
|
+
validationRules: {},
|
|
1399
|
+
operationMetadata: {
|
|
1400
|
+
common_errors: [
|
|
1401
|
+
{
|
|
1402
|
+
code: 401,
|
|
1403
|
+
message: "Authentication required",
|
|
1404
|
+
solution: "Provide valid API credentials",
|
|
1405
|
+
},
|
|
1406
|
+
{
|
|
1407
|
+
code: 403,
|
|
1408
|
+
message: "Permission denied",
|
|
1409
|
+
solution: "Check access permissions for this operation",
|
|
1410
|
+
},
|
|
1411
|
+
{
|
|
1412
|
+
code: 404,
|
|
1413
|
+
message: "Resource not found",
|
|
1414
|
+
solution: "Verify resource name, namespace, and path",
|
|
1415
|
+
},
|
|
1416
|
+
{
|
|
1417
|
+
code: 409,
|
|
1418
|
+
message: "Resource already exists",
|
|
1419
|
+
solution: "Use different name or update existing resource",
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
code: 429,
|
|
1423
|
+
message: "Rate limit exceeded",
|
|
1424
|
+
solution: "Wait before retrying the operation",
|
|
1425
|
+
},
|
|
1426
|
+
{
|
|
1427
|
+
code: 500,
|
|
1428
|
+
message: "Server error",
|
|
1429
|
+
solution: "Retry operation or contact support",
|
|
1430
|
+
},
|
|
1431
|
+
],
|
|
1432
|
+
conditions: {
|
|
1433
|
+
postconditions: ["Resource updated with new values"],
|
|
1434
|
+
prerequisites: ["Active namespace"],
|
|
1435
|
+
},
|
|
1436
|
+
confirmation_required: false,
|
|
1437
|
+
danger_level: "medium",
|
|
1438
|
+
field_docs: {},
|
|
1439
|
+
optional_fields: [],
|
|
1440
|
+
performance_impact: {
|
|
1441
|
+
latency: "low",
|
|
1442
|
+
resource_usage: "low",
|
|
1443
|
+
},
|
|
1444
|
+
purpose: "Replace existing tpm-api-key",
|
|
1445
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1446
|
+
side_effects: {
|
|
1447
|
+
modifies: ["tpm-api-key"],
|
|
1448
|
+
},
|
|
1449
|
+
},
|
|
1450
|
+
curlExample: null,
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-category-create",
|
|
1454
|
+
method: "POST",
|
|
1455
|
+
path: "/api/tpm/namespaces/{metadata.namespace}/tpm_categorys",
|
|
1456
|
+
operation: "create",
|
|
1457
|
+
domain: "bot_and_threat_defense",
|
|
1458
|
+
resource: "tpm-category",
|
|
1459
|
+
summary: "Create TPM Category.",
|
|
1460
|
+
description: "Create a Category object, which is a grouping of APIKeys used for TPM provisioning.",
|
|
1461
|
+
pathParameters: [
|
|
1462
|
+
{
|
|
1463
|
+
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 ""',
|
|
1464
|
+
in: "path",
|
|
1465
|
+
name: "metadata.namespace",
|
|
1466
|
+
required: true,
|
|
1467
|
+
schema: {
|
|
1468
|
+
type: "string",
|
|
1469
|
+
},
|
|
1470
|
+
"x-displayname": "Namespace",
|
|
1471
|
+
"x-ves-example": "Staging",
|
|
1472
|
+
},
|
|
1473
|
+
],
|
|
1474
|
+
queryParameters: [],
|
|
1475
|
+
requestBodySchema: {
|
|
1476
|
+
$ref: "#/components/schemas/tpm_categoryCreateRequest",
|
|
1477
|
+
},
|
|
1478
|
+
responseSchema: {
|
|
1479
|
+
$ref: "#/components/schemas/tpm_categoryCreateResponse",
|
|
1480
|
+
},
|
|
1481
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1482
|
+
operationId: "ves.io.schema.tpm_category.API.Create",
|
|
1483
|
+
tags: ["Other"],
|
|
1484
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1485
|
+
displayName: null,
|
|
1486
|
+
dangerLevel: "medium",
|
|
1487
|
+
sideEffects: {
|
|
1488
|
+
creates: ["tpm-category"],
|
|
1489
|
+
},
|
|
1490
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1491
|
+
confirmationRequired: false,
|
|
1492
|
+
parameterExamples: {
|
|
1493
|
+
"metadata.namespace": "Staging",
|
|
1494
|
+
},
|
|
1495
|
+
validationRules: {},
|
|
1496
|
+
operationMetadata: {
|
|
1497
|
+
common_errors: [
|
|
1498
|
+
{
|
|
1499
|
+
code: 401,
|
|
1500
|
+
message: "Authentication required",
|
|
1501
|
+
solution: "Provide valid API credentials",
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
code: 403,
|
|
1505
|
+
message: "Permission denied",
|
|
1506
|
+
solution: "Check access permissions for this operation",
|
|
1507
|
+
},
|
|
1508
|
+
{
|
|
1509
|
+
code: 404,
|
|
1510
|
+
message: "Resource not found",
|
|
1511
|
+
solution: "Verify resource name, namespace, and path",
|
|
1512
|
+
},
|
|
1513
|
+
{
|
|
1514
|
+
code: 409,
|
|
1515
|
+
message: "Resource already exists",
|
|
1516
|
+
solution: "Use different name or update existing resource",
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
code: 429,
|
|
1520
|
+
message: "Rate limit exceeded",
|
|
1521
|
+
solution: "Wait before retrying the operation",
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
code: 500,
|
|
1525
|
+
message: "Server error",
|
|
1526
|
+
solution: "Retry operation or contact support",
|
|
1527
|
+
},
|
|
1528
|
+
],
|
|
1529
|
+
conditions: {
|
|
1530
|
+
postconditions: ["Tpm-category resource created", "Resource assigned unique identifier"],
|
|
1531
|
+
prerequisites: ["Active namespace"],
|
|
1532
|
+
},
|
|
1533
|
+
confirmation_required: false,
|
|
1534
|
+
danger_level: "medium",
|
|
1535
|
+
field_docs: {},
|
|
1536
|
+
optional_fields: [],
|
|
1537
|
+
performance_impact: {
|
|
1538
|
+
latency: "low",
|
|
1539
|
+
resource_usage: "low",
|
|
1540
|
+
},
|
|
1541
|
+
purpose: "Create new tpm-category",
|
|
1542
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1543
|
+
side_effects: {
|
|
1544
|
+
creates: ["tpm-category"],
|
|
1545
|
+
},
|
|
1546
|
+
},
|
|
1547
|
+
curlExample: null,
|
|
1548
|
+
},
|
|
1549
|
+
{
|
|
1550
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-category-get",
|
|
1551
|
+
method: "GET",
|
|
1552
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_categorys/{name}",
|
|
1553
|
+
operation: "get",
|
|
1554
|
+
domain: "bot_and_threat_defense",
|
|
1555
|
+
resource: "tpm-category",
|
|
1556
|
+
summary: "GET TPM Category.",
|
|
1557
|
+
description: "Retrieve an APIKey object.",
|
|
1558
|
+
pathParameters: [
|
|
1559
|
+
{
|
|
1560
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1561
|
+
in: "path",
|
|
1562
|
+
name: "name",
|
|
1563
|
+
required: true,
|
|
1564
|
+
schema: {
|
|
1565
|
+
type: "string",
|
|
1566
|
+
},
|
|
1567
|
+
"x-displayname": "Name",
|
|
1568
|
+
"x-ves-example": "Name",
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1572
|
+
in: "path",
|
|
1573
|
+
name: "namespace",
|
|
1574
|
+
required: true,
|
|
1575
|
+
schema: {
|
|
1576
|
+
type: "string",
|
|
1577
|
+
},
|
|
1578
|
+
"x-displayname": "Namespace",
|
|
1579
|
+
"x-ves-example": "Ns1",
|
|
1580
|
+
},
|
|
1581
|
+
],
|
|
1582
|
+
queryParameters: [
|
|
1583
|
+
{
|
|
1584
|
+
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.",
|
|
1585
|
+
in: "query",
|
|
1586
|
+
name: "response_format",
|
|
1587
|
+
required: false,
|
|
1588
|
+
schema: {
|
|
1589
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1590
|
+
enum: [
|
|
1591
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1592
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1593
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1594
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1595
|
+
"GET_RSP_FORMAT_READ",
|
|
1596
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1597
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1598
|
+
],
|
|
1599
|
+
type: "string",
|
|
1600
|
+
},
|
|
1601
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1602
|
+
},
|
|
1603
|
+
],
|
|
1604
|
+
requestBodySchema: null,
|
|
1605
|
+
responseSchema: {
|
|
1606
|
+
$ref: "#/components/schemas/tpm_categoryGetResponse",
|
|
1607
|
+
},
|
|
1608
|
+
requiredParams: ["name", "namespace"],
|
|
1609
|
+
operationId: "ves.io.schema.tpm_category.API.Get",
|
|
1610
|
+
tags: ["Other"],
|
|
1611
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1612
|
+
displayName: null,
|
|
1613
|
+
dangerLevel: "low",
|
|
1614
|
+
sideEffects: null,
|
|
1615
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1616
|
+
confirmationRequired: false,
|
|
1617
|
+
parameterExamples: {
|
|
1618
|
+
name: "Name",
|
|
1619
|
+
namespace: "Ns1",
|
|
1620
|
+
},
|
|
1621
|
+
validationRules: {},
|
|
1622
|
+
operationMetadata: {
|
|
1623
|
+
common_errors: [
|
|
1624
|
+
{
|
|
1625
|
+
code: 401,
|
|
1626
|
+
message: "Authentication required",
|
|
1627
|
+
solution: "Provide valid API credentials",
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
code: 403,
|
|
1631
|
+
message: "Permission denied",
|
|
1632
|
+
solution: "Check access permissions for this operation",
|
|
1633
|
+
},
|
|
1634
|
+
{
|
|
1635
|
+
code: 404,
|
|
1636
|
+
message: "Resource not found",
|
|
1637
|
+
solution: "Verify resource name, namespace, and path",
|
|
1638
|
+
},
|
|
1639
|
+
{
|
|
1640
|
+
code: 409,
|
|
1641
|
+
message: "Resource already exists",
|
|
1642
|
+
solution: "Use different name or update existing resource",
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
code: 429,
|
|
1646
|
+
message: "Rate limit exceeded",
|
|
1647
|
+
solution: "Wait before retrying the operation",
|
|
1648
|
+
},
|
|
1649
|
+
{
|
|
1650
|
+
code: 500,
|
|
1651
|
+
message: "Server error",
|
|
1652
|
+
solution: "Retry operation or contact support",
|
|
1653
|
+
},
|
|
1654
|
+
],
|
|
1655
|
+
conditions: {
|
|
1656
|
+
postconditions: [],
|
|
1657
|
+
prerequisites: ["Active namespace"],
|
|
1658
|
+
},
|
|
1659
|
+
confirmation_required: false,
|
|
1660
|
+
danger_level: "low",
|
|
1661
|
+
field_docs: {},
|
|
1662
|
+
optional_fields: [],
|
|
1663
|
+
performance_impact: {
|
|
1664
|
+
latency: "low",
|
|
1665
|
+
resource_usage: "low",
|
|
1666
|
+
},
|
|
1667
|
+
purpose: "Retrieve specific tpm-category",
|
|
1668
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1669
|
+
side_effects: {},
|
|
1670
|
+
},
|
|
1671
|
+
curlExample: null,
|
|
1672
|
+
},
|
|
1673
|
+
{
|
|
1674
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-category-list",
|
|
1675
|
+
method: "GET",
|
|
1676
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_categorys",
|
|
1677
|
+
operation: "list",
|
|
1678
|
+
domain: "bot_and_threat_defense",
|
|
1679
|
+
resource: "tpm-category",
|
|
1680
|
+
summary: "List TPM Category.",
|
|
1681
|
+
description: "List the set of tpm_category in a namespace.",
|
|
1682
|
+
pathParameters: [
|
|
1683
|
+
{
|
|
1684
|
+
description: "Namespace\nNamespace to scope the listing of tpm_category.",
|
|
1685
|
+
in: "path",
|
|
1686
|
+
name: "namespace",
|
|
1687
|
+
required: true,
|
|
1688
|
+
schema: {
|
|
1689
|
+
type: "string",
|
|
1690
|
+
},
|
|
1691
|
+
"x-displayname": "Namespace",
|
|
1692
|
+
"x-ves-example": "Ns1",
|
|
1693
|
+
},
|
|
1694
|
+
],
|
|
1695
|
+
queryParameters: [
|
|
1696
|
+
{
|
|
1697
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1698
|
+
in: "query",
|
|
1699
|
+
name: "label_filter",
|
|
1700
|
+
required: false,
|
|
1701
|
+
schema: {
|
|
1702
|
+
type: "string",
|
|
1703
|
+
},
|
|
1704
|
+
"x-displayname": "Label Filter.",
|
|
1705
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1709
|
+
in: "query",
|
|
1710
|
+
name: "report_fields",
|
|
1711
|
+
required: false,
|
|
1712
|
+
schema: {
|
|
1713
|
+
items: {
|
|
1714
|
+
type: "string",
|
|
1715
|
+
},
|
|
1716
|
+
type: "array",
|
|
1717
|
+
},
|
|
1718
|
+
"x-displayname": "Report Fields.",
|
|
1719
|
+
},
|
|
1720
|
+
{
|
|
1721
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1722
|
+
in: "query",
|
|
1723
|
+
name: "report_status_fields",
|
|
1724
|
+
required: false,
|
|
1725
|
+
schema: {
|
|
1726
|
+
items: {
|
|
1727
|
+
type: "string",
|
|
1728
|
+
},
|
|
1729
|
+
type: "array",
|
|
1730
|
+
},
|
|
1731
|
+
"x-displayname": "Report Status Fields.",
|
|
1732
|
+
},
|
|
1733
|
+
],
|
|
1734
|
+
requestBodySchema: null,
|
|
1735
|
+
responseSchema: {
|
|
1736
|
+
$ref: "#/components/schemas/tpm_categoryListResponse",
|
|
1737
|
+
},
|
|
1738
|
+
requiredParams: ["namespace"],
|
|
1739
|
+
operationId: "ves.io.schema.tpm_category.API.List",
|
|
1740
|
+
tags: ["Other"],
|
|
1741
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1742
|
+
displayName: null,
|
|
1743
|
+
dangerLevel: "low",
|
|
1744
|
+
sideEffects: null,
|
|
1745
|
+
requiredFields: ["path.namespace"],
|
|
1746
|
+
confirmationRequired: false,
|
|
1747
|
+
parameterExamples: {
|
|
1748
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1749
|
+
namespace: "Ns1",
|
|
1750
|
+
},
|
|
1751
|
+
validationRules: {},
|
|
1752
|
+
operationMetadata: {
|
|
1753
|
+
common_errors: [
|
|
1754
|
+
{
|
|
1755
|
+
code: 401,
|
|
1756
|
+
message: "Authentication required",
|
|
1757
|
+
solution: "Provide valid API credentials",
|
|
1758
|
+
},
|
|
1759
|
+
{
|
|
1760
|
+
code: 403,
|
|
1761
|
+
message: "Permission denied",
|
|
1762
|
+
solution: "Check access permissions for this operation",
|
|
1763
|
+
},
|
|
1764
|
+
{
|
|
1765
|
+
code: 404,
|
|
1766
|
+
message: "Resource not found",
|
|
1767
|
+
solution: "Verify resource name, namespace, and path",
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
code: 409,
|
|
1771
|
+
message: "Resource already exists",
|
|
1772
|
+
solution: "Use different name or update existing resource",
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
code: 429,
|
|
1776
|
+
message: "Rate limit exceeded",
|
|
1777
|
+
solution: "Wait before retrying the operation",
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
code: 500,
|
|
1781
|
+
message: "Server error",
|
|
1782
|
+
solution: "Retry operation or contact support",
|
|
1783
|
+
},
|
|
1784
|
+
],
|
|
1785
|
+
conditions: {
|
|
1786
|
+
postconditions: [],
|
|
1787
|
+
prerequisites: ["Active namespace"],
|
|
1788
|
+
},
|
|
1789
|
+
confirmation_required: false,
|
|
1790
|
+
danger_level: "low",
|
|
1791
|
+
field_docs: {},
|
|
1792
|
+
optional_fields: [],
|
|
1793
|
+
performance_impact: {
|
|
1794
|
+
latency: "moderate",
|
|
1795
|
+
resource_usage: "moderate",
|
|
1796
|
+
},
|
|
1797
|
+
purpose: "List all tpm-categorys",
|
|
1798
|
+
required_fields: ["path.namespace"],
|
|
1799
|
+
side_effects: {},
|
|
1800
|
+
},
|
|
1801
|
+
curlExample: null,
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-category-update",
|
|
1805
|
+
method: "PUT",
|
|
1806
|
+
path: "/api/tpm/namespaces/{metadata.namespace}/tpm_categorys/{metadata.name}",
|
|
1807
|
+
operation: "update",
|
|
1808
|
+
domain: "bot_and_threat_defense",
|
|
1809
|
+
resource: "tpm-category",
|
|
1810
|
+
summary: "Replace TPM Category.",
|
|
1811
|
+
description: "Replace a Category object's Allow list of TPM EK Certificates.",
|
|
1812
|
+
pathParameters: [
|
|
1813
|
+
{
|
|
1814
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1815
|
+
in: "path",
|
|
1816
|
+
name: "metadata.name",
|
|
1817
|
+
required: true,
|
|
1818
|
+
schema: {
|
|
1819
|
+
type: "string",
|
|
1820
|
+
},
|
|
1821
|
+
"x-displayname": "Name",
|
|
1822
|
+
"x-ves-example": "Example-corp-web.",
|
|
1823
|
+
},
|
|
1824
|
+
{
|
|
1825
|
+
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 ""',
|
|
1826
|
+
in: "path",
|
|
1827
|
+
name: "metadata.namespace",
|
|
1828
|
+
required: true,
|
|
1829
|
+
schema: {
|
|
1830
|
+
type: "string",
|
|
1831
|
+
},
|
|
1832
|
+
"x-displayname": "Namespace",
|
|
1833
|
+
"x-ves-example": "Staging",
|
|
1834
|
+
},
|
|
1835
|
+
],
|
|
1836
|
+
queryParameters: [],
|
|
1837
|
+
requestBodySchema: {
|
|
1838
|
+
$ref: "#/components/schemas/tpm_categoryReplaceRequest",
|
|
1839
|
+
},
|
|
1840
|
+
responseSchema: {
|
|
1841
|
+
$ref: "#/components/schemas/tpm_categoryReplaceResponse",
|
|
1842
|
+
},
|
|
1843
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1844
|
+
operationId: "ves.io.schema.tpm_category.API.Replace",
|
|
1845
|
+
tags: ["Other"],
|
|
1846
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1847
|
+
displayName: null,
|
|
1848
|
+
dangerLevel: "medium",
|
|
1849
|
+
sideEffects: {
|
|
1850
|
+
modifies: ["tpm-category"],
|
|
1851
|
+
},
|
|
1852
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1853
|
+
confirmationRequired: false,
|
|
1854
|
+
parameterExamples: {
|
|
1855
|
+
"metadata.name": "Example-corp-web.",
|
|
1856
|
+
"metadata.namespace": "Staging",
|
|
1857
|
+
},
|
|
1858
|
+
validationRules: {},
|
|
1859
|
+
operationMetadata: {
|
|
1860
|
+
common_errors: [
|
|
1861
|
+
{
|
|
1862
|
+
code: 401,
|
|
1863
|
+
message: "Authentication required",
|
|
1864
|
+
solution: "Provide valid API credentials",
|
|
1865
|
+
},
|
|
1866
|
+
{
|
|
1867
|
+
code: 403,
|
|
1868
|
+
message: "Permission denied",
|
|
1869
|
+
solution: "Check access permissions for this operation",
|
|
1870
|
+
},
|
|
1871
|
+
{
|
|
1872
|
+
code: 404,
|
|
1873
|
+
message: "Resource not found",
|
|
1874
|
+
solution: "Verify resource name, namespace, and path",
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
code: 409,
|
|
1878
|
+
message: "Resource already exists",
|
|
1879
|
+
solution: "Use different name or update existing resource",
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
code: 429,
|
|
1883
|
+
message: "Rate limit exceeded",
|
|
1884
|
+
solution: "Wait before retrying the operation",
|
|
1885
|
+
},
|
|
1886
|
+
{
|
|
1887
|
+
code: 500,
|
|
1888
|
+
message: "Server error",
|
|
1889
|
+
solution: "Retry operation or contact support",
|
|
1890
|
+
},
|
|
1891
|
+
],
|
|
1892
|
+
conditions: {
|
|
1893
|
+
postconditions: ["Resource updated with new values"],
|
|
1894
|
+
prerequisites: ["Active namespace"],
|
|
1895
|
+
},
|
|
1896
|
+
confirmation_required: false,
|
|
1897
|
+
danger_level: "medium",
|
|
1898
|
+
field_docs: {},
|
|
1899
|
+
optional_fields: [],
|
|
1900
|
+
performance_impact: {
|
|
1901
|
+
latency: "low",
|
|
1902
|
+
resource_usage: "low",
|
|
1903
|
+
},
|
|
1904
|
+
purpose: "Replace existing tpm-category",
|
|
1905
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1906
|
+
side_effects: {
|
|
1907
|
+
modifies: ["tpm-category"],
|
|
1908
|
+
},
|
|
1909
|
+
},
|
|
1910
|
+
curlExample: null,
|
|
1911
|
+
},
|
|
1912
|
+
{
|
|
1913
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-manager-create",
|
|
1914
|
+
method: "POST",
|
|
1915
|
+
path: "/api/tpm/namespaces/{metadata.namespace}/tpm_managers",
|
|
1916
|
+
operation: "create",
|
|
1917
|
+
domain: "bot_and_threat_defense",
|
|
1918
|
+
resource: "tpm-manager",
|
|
1919
|
+
summary: "Create TPM Manager.",
|
|
1920
|
+
description: "Create a TPM Manager object.",
|
|
1921
|
+
pathParameters: [
|
|
1922
|
+
{
|
|
1923
|
+
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 ""',
|
|
1924
|
+
in: "path",
|
|
1925
|
+
name: "metadata.namespace",
|
|
1926
|
+
required: true,
|
|
1927
|
+
schema: {
|
|
1928
|
+
type: "string",
|
|
1929
|
+
},
|
|
1930
|
+
"x-displayname": "Namespace",
|
|
1931
|
+
"x-ves-example": "Staging",
|
|
1932
|
+
},
|
|
1933
|
+
],
|
|
1934
|
+
queryParameters: [],
|
|
1935
|
+
requestBodySchema: {
|
|
1936
|
+
$ref: "#/components/schemas/tpm_managerCreateRequest",
|
|
1937
|
+
},
|
|
1938
|
+
responseSchema: {
|
|
1939
|
+
$ref: "#/components/schemas/tpm_managerCreateResponse",
|
|
1940
|
+
},
|
|
1941
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1942
|
+
operationId: "ves.io.schema.tpm_manager.API.Create",
|
|
1943
|
+
tags: ["Other"],
|
|
1944
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
1945
|
+
displayName: null,
|
|
1946
|
+
dangerLevel: "medium",
|
|
1947
|
+
sideEffects: {
|
|
1948
|
+
creates: ["tpm-manager"],
|
|
1949
|
+
},
|
|
1950
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1951
|
+
confirmationRequired: false,
|
|
1952
|
+
parameterExamples: {
|
|
1953
|
+
"metadata.namespace": "Staging",
|
|
1954
|
+
},
|
|
1955
|
+
validationRules: {},
|
|
1956
|
+
operationMetadata: {
|
|
1957
|
+
common_errors: [
|
|
1958
|
+
{
|
|
1959
|
+
code: 401,
|
|
1960
|
+
message: "Authentication required",
|
|
1961
|
+
solution: "Provide valid API credentials",
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
code: 403,
|
|
1965
|
+
message: "Permission denied",
|
|
1966
|
+
solution: "Check access permissions for this operation",
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
code: 404,
|
|
1970
|
+
message: "Resource not found",
|
|
1971
|
+
solution: "Verify resource name, namespace, and path",
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
code: 409,
|
|
1975
|
+
message: "Resource already exists",
|
|
1976
|
+
solution: "Use different name or update existing resource",
|
|
1977
|
+
},
|
|
1978
|
+
{
|
|
1979
|
+
code: 429,
|
|
1980
|
+
message: "Rate limit exceeded",
|
|
1981
|
+
solution: "Wait before retrying the operation",
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
code: 500,
|
|
1985
|
+
message: "Server error",
|
|
1986
|
+
solution: "Retry operation or contact support",
|
|
1987
|
+
},
|
|
1988
|
+
],
|
|
1989
|
+
conditions: {
|
|
1990
|
+
postconditions: ["Tpm-manager resource created", "Resource assigned unique identifier"],
|
|
1991
|
+
prerequisites: ["Active namespace"],
|
|
1992
|
+
},
|
|
1993
|
+
confirmation_required: false,
|
|
1994
|
+
danger_level: "medium",
|
|
1995
|
+
field_docs: {},
|
|
1996
|
+
optional_fields: [],
|
|
1997
|
+
performance_impact: {
|
|
1998
|
+
latency: "low",
|
|
1999
|
+
resource_usage: "low",
|
|
2000
|
+
},
|
|
2001
|
+
purpose: "Create new tpm-manager",
|
|
2002
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
2003
|
+
side_effects: {
|
|
2004
|
+
creates: ["tpm-manager"],
|
|
2005
|
+
},
|
|
2006
|
+
},
|
|
2007
|
+
curlExample: null,
|
|
2008
|
+
},
|
|
2009
|
+
{
|
|
2010
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-manager-get",
|
|
2011
|
+
method: "GET",
|
|
2012
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_managers/{name}",
|
|
2013
|
+
operation: "get",
|
|
2014
|
+
domain: "bot_and_threat_defense",
|
|
2015
|
+
resource: "tpm-manager",
|
|
2016
|
+
summary: "GET TPM Manager.",
|
|
2017
|
+
description: "Retrieve a TPM Manager object.",
|
|
2018
|
+
pathParameters: [
|
|
2019
|
+
{
|
|
2020
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2021
|
+
in: "path",
|
|
2022
|
+
name: "name",
|
|
2023
|
+
required: true,
|
|
2024
|
+
schema: {
|
|
2025
|
+
type: "string",
|
|
2026
|
+
},
|
|
2027
|
+
"x-displayname": "Name",
|
|
2028
|
+
"x-ves-example": "Name",
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2032
|
+
in: "path",
|
|
2033
|
+
name: "namespace",
|
|
2034
|
+
required: true,
|
|
2035
|
+
schema: {
|
|
2036
|
+
type: "string",
|
|
2037
|
+
},
|
|
2038
|
+
"x-displayname": "Namespace",
|
|
2039
|
+
"x-ves-example": "Ns1",
|
|
2040
|
+
},
|
|
2041
|
+
],
|
|
2042
|
+
queryParameters: [
|
|
2043
|
+
{
|
|
2044
|
+
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 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.",
|
|
2045
|
+
in: "query",
|
|
2046
|
+
name: "response_format",
|
|
2047
|
+
required: false,
|
|
2048
|
+
schema: {
|
|
2049
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2050
|
+
enum: [
|
|
2051
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2052
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2053
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2054
|
+
"GET_RSP_FORMAT_READ",
|
|
2055
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2056
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2057
|
+
],
|
|
2058
|
+
type: "string",
|
|
2059
|
+
},
|
|
2060
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2061
|
+
},
|
|
2062
|
+
],
|
|
2063
|
+
requestBodySchema: null,
|
|
2064
|
+
responseSchema: {
|
|
2065
|
+
$ref: "#/components/schemas/tpm_managerGetResponse",
|
|
2066
|
+
},
|
|
2067
|
+
requiredParams: ["name", "namespace"],
|
|
2068
|
+
operationId: "ves.io.schema.tpm_manager.API.Get",
|
|
2069
|
+
tags: ["Other"],
|
|
2070
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
2071
|
+
displayName: null,
|
|
2072
|
+
dangerLevel: "low",
|
|
2073
|
+
sideEffects: null,
|
|
2074
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2075
|
+
confirmationRequired: false,
|
|
2076
|
+
parameterExamples: {
|
|
2077
|
+
name: "Name",
|
|
2078
|
+
namespace: "Ns1",
|
|
2079
|
+
},
|
|
2080
|
+
validationRules: {},
|
|
2081
|
+
operationMetadata: {
|
|
2082
|
+
common_errors: [
|
|
2083
|
+
{
|
|
2084
|
+
code: 401,
|
|
2085
|
+
message: "Authentication required",
|
|
2086
|
+
solution: "Provide valid API credentials",
|
|
2087
|
+
},
|
|
2088
|
+
{
|
|
2089
|
+
code: 403,
|
|
2090
|
+
message: "Permission denied",
|
|
2091
|
+
solution: "Check access permissions for this operation",
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
code: 404,
|
|
2095
|
+
message: "Resource not found",
|
|
2096
|
+
solution: "Verify resource name, namespace, and path",
|
|
2097
|
+
},
|
|
2098
|
+
{
|
|
2099
|
+
code: 409,
|
|
2100
|
+
message: "Resource already exists",
|
|
2101
|
+
solution: "Use different name or update existing resource",
|
|
2102
|
+
},
|
|
2103
|
+
{
|
|
2104
|
+
code: 429,
|
|
2105
|
+
message: "Rate limit exceeded",
|
|
2106
|
+
solution: "Wait before retrying the operation",
|
|
2107
|
+
},
|
|
2108
|
+
{
|
|
2109
|
+
code: 500,
|
|
2110
|
+
message: "Server error",
|
|
2111
|
+
solution: "Retry operation or contact support",
|
|
2112
|
+
},
|
|
2113
|
+
],
|
|
2114
|
+
conditions: {
|
|
2115
|
+
postconditions: [],
|
|
2116
|
+
prerequisites: ["Active namespace"],
|
|
2117
|
+
},
|
|
2118
|
+
confirmation_required: false,
|
|
2119
|
+
danger_level: "low",
|
|
2120
|
+
field_docs: {},
|
|
2121
|
+
optional_fields: [],
|
|
2122
|
+
performance_impact: {
|
|
2123
|
+
latency: "low",
|
|
2124
|
+
resource_usage: "low",
|
|
2125
|
+
},
|
|
2126
|
+
purpose: "Retrieve specific tpm-manager",
|
|
2127
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2128
|
+
side_effects: {},
|
|
2129
|
+
},
|
|
2130
|
+
curlExample: null,
|
|
2131
|
+
},
|
|
2132
|
+
{
|
|
2133
|
+
toolName: "f5xc-api-botandthreatdefense-tpm-manager-list",
|
|
2134
|
+
method: "GET",
|
|
2135
|
+
path: "/api/tpm/namespaces/{namespace}/tpm_managers",
|
|
2136
|
+
operation: "list",
|
|
2137
|
+
domain: "bot_and_threat_defense",
|
|
2138
|
+
resource: "tpm-manager",
|
|
2139
|
+
summary: "List TPM Manager.",
|
|
2140
|
+
description: "List the set of tpm_manager in a namespace.",
|
|
2141
|
+
pathParameters: [
|
|
2142
|
+
{
|
|
2143
|
+
description: "Namespace\nNamespace to scope the listing of tpm_manager.",
|
|
2144
|
+
in: "path",
|
|
2145
|
+
name: "namespace",
|
|
2146
|
+
required: true,
|
|
2147
|
+
schema: {
|
|
2148
|
+
type: "string",
|
|
2149
|
+
},
|
|
2150
|
+
"x-displayname": "Namespace",
|
|
2151
|
+
"x-ves-example": "Ns1",
|
|
2152
|
+
},
|
|
2153
|
+
],
|
|
2154
|
+
queryParameters: [
|
|
2155
|
+
{
|
|
2156
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2157
|
+
in: "query",
|
|
2158
|
+
name: "label_filter",
|
|
2159
|
+
required: false,
|
|
2160
|
+
schema: {
|
|
2161
|
+
type: "string",
|
|
2162
|
+
},
|
|
2163
|
+
"x-displayname": "Label Filter.",
|
|
2164
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2168
|
+
in: "query",
|
|
2169
|
+
name: "report_fields",
|
|
2170
|
+
required: false,
|
|
2171
|
+
schema: {
|
|
2172
|
+
items: {
|
|
2173
|
+
type: "string",
|
|
2174
|
+
},
|
|
2175
|
+
type: "array",
|
|
2176
|
+
},
|
|
2177
|
+
"x-displayname": "Report Fields.",
|
|
2178
|
+
},
|
|
2179
|
+
{
|
|
2180
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2181
|
+
in: "query",
|
|
2182
|
+
name: "report_status_fields",
|
|
2183
|
+
required: false,
|
|
2184
|
+
schema: {
|
|
2185
|
+
items: {
|
|
2186
|
+
type: "string",
|
|
2187
|
+
},
|
|
2188
|
+
type: "array",
|
|
2189
|
+
},
|
|
2190
|
+
"x-displayname": "Report Status Fields.",
|
|
2191
|
+
},
|
|
2192
|
+
],
|
|
2193
|
+
requestBodySchema: null,
|
|
2194
|
+
responseSchema: {
|
|
2195
|
+
$ref: "#/components/schemas/tpm_managerListResponse",
|
|
2196
|
+
},
|
|
2197
|
+
requiredParams: ["namespace"],
|
|
2198
|
+
operationId: "ves.io.schema.tpm_manager.API.List",
|
|
2199
|
+
tags: ["Other"],
|
|
2200
|
+
sourceFile: "domains/bot_and_threat_defense.json",
|
|
2201
|
+
displayName: null,
|
|
2202
|
+
dangerLevel: "low",
|
|
2203
|
+
sideEffects: null,
|
|
2204
|
+
requiredFields: ["path.namespace"],
|
|
2205
|
+
confirmationRequired: false,
|
|
2206
|
+
parameterExamples: {
|
|
2207
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2208
|
+
namespace: "Ns1",
|
|
2209
|
+
},
|
|
2210
|
+
validationRules: {},
|
|
2211
|
+
operationMetadata: {
|
|
2212
|
+
common_errors: [
|
|
2213
|
+
{
|
|
2214
|
+
code: 401,
|
|
2215
|
+
message: "Authentication required",
|
|
2216
|
+
solution: "Provide valid API credentials",
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
code: 403,
|
|
2220
|
+
message: "Permission denied",
|
|
2221
|
+
solution: "Check access permissions for this operation",
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
code: 404,
|
|
2225
|
+
message: "Resource not found",
|
|
2226
|
+
solution: "Verify resource name, namespace, and path",
|
|
2227
|
+
},
|
|
2228
|
+
{
|
|
2229
|
+
code: 409,
|
|
2230
|
+
message: "Resource already exists",
|
|
2231
|
+
solution: "Use different name or update existing resource",
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
code: 429,
|
|
2235
|
+
message: "Rate limit exceeded",
|
|
2236
|
+
solution: "Wait before retrying the operation",
|
|
2237
|
+
},
|
|
2238
|
+
{
|
|
2239
|
+
code: 500,
|
|
2240
|
+
message: "Server error",
|
|
2241
|
+
solution: "Retry operation or contact support",
|
|
2242
|
+
},
|
|
2243
|
+
],
|
|
2244
|
+
conditions: {
|
|
2245
|
+
postconditions: [],
|
|
2246
|
+
prerequisites: ["Active namespace"],
|
|
2247
|
+
},
|
|
2248
|
+
confirmation_required: false,
|
|
2249
|
+
danger_level: "low",
|
|
2250
|
+
field_docs: {},
|
|
2251
|
+
optional_fields: [],
|
|
2252
|
+
performance_impact: {
|
|
2253
|
+
latency: "moderate",
|
|
2254
|
+
resource_usage: "moderate",
|
|
2255
|
+
},
|
|
2256
|
+
purpose: "List all tpm-managers",
|
|
2257
|
+
required_fields: ["path.namespace"],
|
|
2258
|
+
side_effects: {},
|
|
2259
|
+
},
|
|
2260
|
+
curlExample: null,
|
|
2261
|
+
},
|
|
2262
|
+
];
|
|
2263
|
+
export default bot_and_threat_defenseTools;
|
|
2264
|
+
//# sourceMappingURL=index.js.map
|