@robinmordasiewicz/f5xc-api-mcp 1.0.82-2512312028

package/dist/tools/generated/secops_and_incident_response/index.js

@@ -0,0 +1,710 @@
+/**
+ * Generated tool definitions for secops_and_incident_response domain
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
+ */
+export const secops_and_incident_responseTools = [
+    {
+        toolName: "f5xc-api-secopsandincidentresponse-malicious-user-mitigation-create",
+        method: "POST",
+        path: "/api/config/namespaces/{metadata.namespace}/malicious_user_mitigations",
+        operation: "create",
+        domain: "secops_and_incident_response",
+        resource: "malicious-user-mitigation",
+        summary: "Create Malicious User Mitigation.",
+        description: "Create malicious_user_mitigation creates a new object in the storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                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 ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Staging",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationCreateRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationCreateResponse",
+        },
+        requiredParams: ["body", "metadata.namespace"],
+        operationId: "ves.io.schema.malicious_user_mitigation.API.Create",
+        tags: ["Other"],
+        sourceFile: "domains/secops_and_incident_response.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["malicious-user-mitigation"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
+        confirmationRequired: false,
+        parameterExamples: {
+            "metadata.namespace": "Staging",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [
+                    "Malicious-user-mitigation resource created",
+                    "Resource assigned unique identifier",
+                ],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new malicious-user-mitigation",
+            required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
+            side_effects: {
+                creates: ["malicious-user-mitigation"],
+            },
+        },
+        curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/malicious_user_mitigations" \\\n  -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d @example.json',
+        dependencies: [
+            {
+                domain: "",
+                fieldPath: "",
+                inline: false,
+                required: false,
+                resourceType: "malicious-user-mitigation",
+            },
+            {
+                domain: "",
+                fieldPath: "metadata",
+                inline: false,
+                required: false,
+                resourceType: "schema-object-create-meta",
+            },
+            {
+                domain: "",
+                fieldPath: "spec",
+                inline: false,
+                required: false,
+                resourceType: "malicious-user-mitigation-create",
+            },
+        ],
+        oneOfGroups: [],
+        subscriptionRequirements: [
+            {
+                addonService: "f5xc_waap_standard",
+                displayName: "F5XC WAAP Standard",
+                required: false,
+                tier: "standard",
+            },
+            {
+                addonService: "f5xc_waap_advanced",
+                displayName: "F5XC WAAP Advanced",
+                required: false,
+                tier: "advanced",
+            },
+        ],
+    },
+    {
+        toolName: "f5xc-api-secopsandincidentresponse-malicious-user-mitigation-delete",
+        method: "DELETE",
+        path: "/api/config/namespaces/{namespace}/malicious_user_mitigations/{name}",
+        operation: "delete",
+        domain: "secops_and_incident_response",
+        resource: "malicious-user-mitigation",
+        summary: "DELETE Malicious User Mitigation.",
+        description: "DELETE the specified malicious_user_mitigation.",
+        pathParameters: [
+            {
+                description: "Name\nName of the configuration object.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Name",
+            },
+            {
+                description: "Namespace\nNamespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationDeleteRequest",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.malicious_user_mitigation.API.Delete",
+        tags: ["Other"],
+        sourceFile: "domains/secops_and_incident_response.json",
+        displayName: null,
+        dangerLevel: "high",
+        sideEffects: {
+            deletes: ["malicious-user-mitigation", "contained_resources"],
+        },
+        requiredFields: ["path.name", "path.namespace"],
+        confirmationRequired: true,
+        parameterExamples: {
+            name: "Name",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Resource removed from system", "Associated resources may be affected"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: true,
+            danger_level: "high",
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "high",
+                resource_usage: "moderate",
+            },
+            purpose: "Delete malicious-user-mitigation",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {
+                deletes: ["malicious-user-mitigation", "contained_resources"],
+            },
+        },
+        curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/malicious_user_mitigations" \\\n  -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d @example.json',
+        dependencies: [
+            {
+                domain: "",
+                fieldPath: "",
+                inline: false,
+                required: false,
+                resourceType: "malicious-user-mitigation",
+            },
+        ],
+        oneOfGroups: [],
+        subscriptionRequirements: [
+            {
+                addonService: "f5xc_waap_standard",
+                displayName: "F5XC WAAP Standard",
+                required: false,
+                tier: "standard",
+            },
+            {
+                addonService: "f5xc_waap_advanced",
+                displayName: "F5XC WAAP Advanced",
+                required: false,
+                tier: "advanced",
+            },
+        ],
+    },
+    {
+        toolName: "f5xc-api-secopsandincidentresponse-malicious-user-mitigation-get",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/malicious_user_mitigations/{name}",
+        operation: "get",
+        domain: "secops_and_incident_response",
+        resource: "malicious-user-mitigation",
+        summary: "GET Malicious User Mitigation.",
+        description: "GET malicious_user_mitigation reads a given object from storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Name",
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        queryParameters: [
+            {
+                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.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_FOR_CREATE",
+                        "GET_RSP_FORMAT_FOR_REPLACE",
+                        "GET_RSP_FORMAT_STATUS",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+                "x-displayname": "Broken Referred Objects.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.malicious_user_mitigation.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/secops_and_incident_response.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.name", "path.namespace"],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "Name",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Retrieve specific malicious-user-mitigation",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {},
+        },
+        curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/malicious_user_mitigations" \\\n  -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d @example.json',
+        dependencies: [],
+        oneOfGroups: [],
+        subscriptionRequirements: [
+            {
+                addonService: "f5xc_waap_standard",
+                displayName: "F5XC WAAP Standard",
+                required: false,
+                tier: "standard",
+            },
+            {
+                addonService: "f5xc_waap_advanced",
+                displayName: "F5XC WAAP Advanced",
+                required: false,
+                tier: "advanced",
+            },
+        ],
+    },
+    {
+        toolName: "f5xc-api-secopsandincidentresponse-malicious-user-mitigation-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/malicious_user_mitigations",
+        operation: "list",
+        domain: "secops_and_incident_response",
+        resource: "malicious-user-mitigation",
+        summary: "List Malicious User Mitigation.",
+        description: "List the set of malicious_user_mitigation in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of malicious_user_mitigation.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Label Filter.",
+                "x-ves-example": "Env in (staging, testing), tier in (web, db)",
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+                "x-displayname": "Report Fields.",
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+                "x-displayname": "Report Status Fields.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.malicious_user_mitigation.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/secops_and_incident_response.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        confirmationRequired: false,
+        parameterExamples: {
+            label_filter: "Env in (staging, testing), tier in (web, db)",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all malicious-user-mitigations",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+        curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/malicious_user_mitigations" \\\n  -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d @example.json',
+        dependencies: [],
+        oneOfGroups: [],
+        subscriptionRequirements: [
+            {
+                addonService: "f5xc_waap_standard",
+                displayName: "F5XC WAAP Standard",
+                required: false,
+                tier: "standard",
+            },
+            {
+                addonService: "f5xc_waap_advanced",
+                displayName: "F5XC WAAP Advanced",
+                required: false,
+                tier: "advanced",
+            },
+        ],
+    },
+    {
+        toolName: "f5xc-api-secopsandincidentresponse-malicious-user-mitigation-update",
+        method: "PUT",
+        path: "/api/config/namespaces/{metadata.namespace}/malicious_user_mitigations/{metadata.name}",
+        operation: "update",
+        domain: "secops_and_incident_response",
+        resource: "malicious-user-mitigation",
+        summary: "Replace Malicious User Mitigation.",
+        description: "Replace malicious_user_mitigation replaces an existing object in the storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe configuration object to be replaced will be looked up by name.",
+                in: "path",
+                name: "metadata.name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Example-corp-web.",
+            },
+            {
+                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 ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Staging",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationReplaceRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/malicious_user_mitigationReplaceResponse",
+        },
+        requiredParams: ["body", "metadata.name", "metadata.namespace"],
+        operationId: "ves.io.schema.malicious_user_mitigation.API.Replace",
+        tags: ["Other"],
+        sourceFile: "domains/secops_and_incident_response.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            modifies: ["malicious-user-mitigation"],
+        },
+        requiredFields: ["path.metadata.name", "path.metadata.namespace"],
+        confirmationRequired: false,
+        parameterExamples: {
+            "metadata.name": "Example-corp-web.",
+            "metadata.namespace": "Staging",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Resource updated with new values"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Replace existing malicious-user-mitigation",
+            required_fields: ["path.metadata.name", "path.metadata.namespace"],
+            side_effects: {
+                modifies: ["malicious-user-mitigation"],
+            },
+        },
+        curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/malicious_user_mitigations" \\\n  -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n  -H "Content-Type: application/json" \\\n  -d @example.json',
+        dependencies: [
+            {
+                domain: "",
+                fieldPath: "",
+                inline: false,
+                required: false,
+                resourceType: "malicious-user-mitigation",
+            },
+            {
+                domain: "",
+                fieldPath: "metadata",
+                inline: false,
+                required: false,
+                resourceType: "schema-object-replace-meta",
+            },
+            {
+                domain: "",
+                fieldPath: "spec",
+                inline: false,
+                required: false,
+                resourceType: "malicious-user-mitigation-replace",
+            },
+        ],
+        oneOfGroups: [],
+        subscriptionRequirements: [
+            {
+                addonService: "f5xc_waap_standard",
+                displayName: "F5XC WAAP Standard",
+                required: false,
+                tier: "standard",
+            },
+            {
+                addonService: "f5xc_waap_advanced",
+                displayName: "F5XC WAAP Advanced",
+                required: false,
+                tier: "advanced",
+            },
+        ],
+    },
+];
+export default secops_and_incident_responseTools;
+//# sourceMappingURL=index.js.map