{ "server": { "name": "Global Private Cloud Network™ (GPCN™) API", "version": "latest", "transport": "http" }, "capabilities": { "tools": { "list_your_tenant_s_alert_subscriptions": { "name": "list_your_tenant_s_alert_subscriptions", "description": "List your tenant's alert subscriptions", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "attach_a_delivery_channel_email_or_webhook_to_a_saved_query": { "name": "attach_a_delivery_channel_email_or_webhook_to_a_saved_query", "description": "Attach a delivery channel (email or webhook) to a saved query", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "savedQueryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The saved query this subscription fires on; must belong to your tenant." }, "channel": { "type": "string", "enum": [ "email", "webhook" ] }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Email channel only. Defaults to your account email when omitted." }, "destination": { "type": "string", "description": "Webhook channel only. The https endpoint to POST matches to." } }, "required": [ "savedQueryId", "channel" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } } } }, "delete_an_alert_subscription": { "name": "delete_an_alert_subscription", "description": "Delete an alert subscription", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Subscription UUID" } }, "required": [ "id" ] } }, "get_a_single_alert_subscription": { "name": "get_a_single_alert_subscription", "description": "Get a single alert subscription", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Subscription UUID" } }, "required": [ "id" ] } }, "update_an_alert_subscription_enable_disable_recipients_rotate_secret": { "name": "update_an_alert_subscription_enable_disable_recipients_rotate_secret", "description": "Update an alert subscription (enable/disable, recipients, rotate secret)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Subscription UUID" }, "body": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "recipients": { "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "rotateSecret": { "type": "boolean", "description": "Webhook channel only. Mints and returns a new signing secret once." } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_audit_events_for_your_tenant": { "name": "list_audit_events_for_your_tenant", "description": "List audit events for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "category": { "type": "string", "enum": [ "auth", "admin", "security", "data", "config", "session", "api_key", "rbac", "resource", "entity", "billing", "audit_log", "job", "system" ], "description": "Filter by event category" }, "action": { "type": "string", "maxLength": 100, "description": "Filter by action string (e.g., `vm.create.succeeded`)" }, "outcome": { "type": "string", "enum": [ "success", "failure", "denied" ], "description": "Filter by outcome" }, "actorUserId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by the user who performed the action" }, "targetType": { "type": "string", "maxLength": 50, "description": "Filter by target resource type (e.g., `virtual_machine`)" }, "targetId": { "type": "string", "maxLength": 64, "description": "Filter by target resource ID" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by the resource group the event's target belonged to when the event was recorded. Events with no group — sign-ins, configuration changes, unassigned resources, and anything recorded before groups were stamped — never match this filter.\nNarrows within your own access, it does not widen it: if your role limits you to specific resource groups, asking for another one returns an empty page." }, "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by async job ID to correlate requested/succeeded/failed event pairs" }, "occurredAfter": { "type": "string", "description": "Return events on or after this ISO-8601 datetime. A bare YYYY-MM-DD date is also accepted." }, "occurredBefore": { "type": "string", "description": "Return events on or before this ISO-8601 datetime. A bare YYYY-MM-DD date is also accepted and is promoted to end-of-day UTC." }, "search": { "type": "string", "maxLength": 200, "description": "Free-text match across actor email, action, target resource name and source IP. `%` and `_` are treated literally.\nRequires `occurredAfter`, and the resulting window may not exceed 92 calendar days inclusive (a date-only `occurredBefore` covers its whole day, so two date-only bounds may differ by at most 91 days) — three of the four searched columns are unindexed, so an unbounded search scans the tenant's entire retained history. Violations return 422 rather than a silently narrowed window: a caller who believes they searched everything would read a partial result as a complete one." }, "privilegedOnly": { "type": "string", "enum": [ "true", "false" ], "description": "When true, return only events flagged as privileged grants" }, "dataExposureOnly": { "type": "string", "enum": [ "true", "false" ], "description": "When true, return only events flagged as data-exposure risks" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "description": "Page number (1-indexed)" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Items per page" }, "sort": { "type": "string", "example": "occurredAt:desc", "description": "Sort field and direction (e.g., `occurredAt:desc`). Accepted fields: `occurredAt`, `category`, `action`, `outcome`, `actorUserEmailAtEventTime`." } } } }, "get_a_single_audit_event_by_id": { "name": "get_a_single_audit_event_by_id", "description": "Get a single audit event by ID", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Audit event UUID" } }, "required": [ "id" ] } }, "list_your_tenant_s_audit_log_export_jobs": { "name": "list_your_tenant_s_audit_log_export_jobs", "description": "List your tenant's audit-log export jobs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "request_a_bulk_audit_log_export_for_your_tenant": { "name": "request_a_bulk_audit_log_export_for_your_tenant", "description": "Request a bulk audit-log export for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "windowStart": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "Start of the export window (ISO-8601). Clamped forward to your retention floor." }, "windowEnd": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "description": "End of the export window (ISO-8601). Must be after windowStart; span ≤ 12 months." }, "format": { "type": "string", "enum": [ "jsonl_bundle", "pdf_summary" ] }, "filters": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Explorer-style filters narrowing which events the export covers. Accepted only for `pdf_summary` — a `jsonl_bundle` is verified against the signed daily manifests, so it must contain every row in the window and a filtered request is rejected with 422. Supported keys: category, action, actions, outcome, actorUserId, targetType, targetId, jobId, privilegedOnly, dataExposureOnly. `search`, `occurredAfter`, `occurredBefore` and `resourceGroupId` are rejected with 422: the export window sets the time range, free-text search is limited to the interactive explorer, and an export always covers the whole entity — it is gated on the entity-wide `resource-group:bypass` grant — so it cannot be narrowed to a single resource group.\n" } }, "required": [ "windowStart", "windowEnd" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": {} } } }, "list_your_tenant_s_recurring_export_schedules": { "name": "list_your_tenant_s_recurring_export_schedules", "description": "List your tenant's recurring export schedules", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "create_a_recurring_audit_log_export_schedule_for_your_tenant": { "name": "create_a_recurring_audit_log_export_schedule_for_your_tenant", "description": "Create a recurring audit-log export schedule for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "cadence": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "hourUtc": { "type": "integer", "minimum": 0, "maximum": 23, "description": "Hour of day (UTC) at which the export runs." }, "dayOfWeek": { "type": "integer", "minimum": 0, "maximum": 6, "description": "Day of week (0=Sunday). Required when cadence is weekly." }, "dayOfMonth": { "type": "integer", "minimum": 1, "maximum": 28, "description": "Day of month. Required when cadence is monthly." }, "format": { "type": "string", "enum": [ "jsonl_bundle", "pdf_summary" ] }, "filters": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Explorer-style filters narrowing which events the export covers. Accepted only for `pdf_summary` — a `jsonl_bundle` is verified against the signed daily manifests, so it must contain every row in the window and a filtered request is rejected with 422. Supported keys: category, action, actions, outcome, actorUserId, targetType, targetId, jobId, privilegedOnly, dataExposureOnly. `search`, `occurredAfter` and `occurredBefore` are rejected: the export window sets the time range, and free-text search is limited to the interactive explorer.\n" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Email recipients for each export. Defaults to your account email when omitted." } }, "required": [ "cadence", "hourUtc" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": {}, "__schema1": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } } } }, "delete_a_recurring_export_schedule": { "name": "delete_a_recurring_export_schedule", "description": "Delete a recurring export schedule", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Export schedule UUID" } }, "required": [ "id" ] } }, "get_a_single_recurring_export_schedule": { "name": "get_a_single_recurring_export_schedule", "description": "Get a single recurring export schedule", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Export schedule UUID" } }, "required": [ "id" ] } }, "update_a_recurring_export_schedule": { "name": "update_a_recurring_export_schedule", "description": "Update a recurring export schedule", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Export schedule UUID" }, "body": { "type": "object", "properties": { "cadence": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "hourUtc": { "type": "integer", "minimum": 0, "maximum": 23 }, "dayOfWeek": { "type": "integer", "minimum": 0, "maximum": 6 }, "dayOfMonth": { "type": "integer", "minimum": 1, "maximum": 28 }, "format": { "type": "string", "enum": [ "jsonl_bundle", "pdf_summary" ] }, "filters": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Explorer-style filters narrowing which events the export covers. Accepted only for `pdf_summary` — a `jsonl_bundle` is verified against the signed daily manifests, so it must contain every row in the window and a filtered request is rejected with 422. Supported keys: category, action, actions, outcome, actorUserId, targetType, targetId, jobId, privilegedOnly, dataExposureOnly. `search`, `occurredAfter` and `occurredBefore` are rejected: the export window sets the time range, and free-text search is limited to the interactive explorer.\n" }, "recipients": { "type": "array", "items": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "enabled": { "type": "boolean", "description": "Whether the schedule is active." } }, "required": [ "cadence", "hourUtc" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": {} } } }, "get_the_status_of_an_audit_log_export_job": { "name": "get_the_status_of_an_audit_log_export_job", "description": "Get the status of an audit-log export job", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Export job UUID" } }, "required": [ "id" ] } }, "get_retention_settings_for_your_tenant": { "name": "get_retention_settings_for_your_tenant", "description": "Get retention settings for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "update_retention_settings_for_your_tenant": { "name": "update_retention_settings_for_your_tenant", "description": "Update retention settings for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "retentionMonths": { "anyOf": [ { "type": "number", "const": 12 }, { "type": "number", "const": 18 }, { "type": "number", "const": 24 }, { "type": "number", "const": 36 }, { "type": "number", "const": 72 } ] } }, "required": [ "retentionMonths" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "list_your_tenant_s_saved_explorer_filters": { "name": "list_your_tenant_s_saved_explorer_filters", "description": "List your tenant's saved explorer filters", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "create_a_saved_audit_log_explorer_filter_for_your_tenant": { "name": "create_a_saved_audit_log_explorer_filter_for_your_tenant", "description": "Create a saved audit-log explorer filter for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Human-readable label for the saved filter." }, "filters": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Explorer-style filters identifying which events the query matches. Accepts the explorer's filter keys — category, action, actions, outcome, actorUserId, targetType, targetId, jobId, search, privilegedOnly, dataExposureOnly — where `actions` matches any of several exact actions.\n`occurredAfter` and `occurredBefore` are accepted but not used when the query drives an alert: each evaluation pass reads the window since its own watermark, so a stored time bound would either duplicate or silently suppress deliveries.\n" } }, "required": [ "name", "filters" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": {} } } }, "delete_a_saved_explorer_filter": { "name": "delete_a_saved_explorer_filter", "description": "Delete a saved explorer filter", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Saved query UUID" } }, "required": [ "id" ] } }, "get_a_single_saved_explorer_filter": { "name": "get_a_single_saved_explorer_filter", "description": "Get a single saved explorer filter", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Saved query UUID" } }, "required": [ "id" ] } }, "update_a_saved_explorer_filter": { "name": "update_a_saved_explorer_filter", "description": "Update a saved explorer filter", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Saved query UUID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "filters": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Same filter vocabulary as create. Replaces the stored set outright — a PUT omitting a previously-saved key clears it.\n" } }, "required": [ "name", "filters" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": {} } } }, "list_your_tenant_s_stream_destinations": { "name": "list_your_tenant_s_stream_destinations", "description": "List your tenant's stream destinations", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "create_a_siem_stream_destination_for_your_tenant": { "name": "create_a_siem_stream_destination_for_your_tenant", "description": "Create a SIEM stream destination for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "transport": { "type": "string", "enum": [ "https", "syslog_tls" ] }, "endpoint": { "type": "string", "description": "For https, an https URL. For syslog_tls, a host:port." }, "customCaPem": { "type": "string", "description": "syslog_tls only. Optional custom CA certificate (PEM)." } }, "required": [ "name", "transport", "endpoint" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "delete_a_stream_destination": { "name": "delete_a_stream_destination", "description": "Delete a stream destination", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Stream destination UUID" } }, "required": [ "id" ] } }, "get_a_single_stream_destination": { "name": "get_a_single_stream_destination", "description": "Get a single stream destination", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Stream destination UUID" } }, "required": [ "id" ] } }, "update_a_stream_destination_rename_swap_endpoint_enable_disable": { "name": "update_a_stream_destination_rename_swap_endpoint_enable_disable", "description": "Update a stream destination (rename, swap endpoint, enable/disable)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Stream destination UUID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "endpoint": { "type": "string" }, "enabled": { "type": "boolean" }, "customCaPem": { "type": "string", "description": "syslog_tls only." } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "get_audit_log_summary_for_your_tenant": { "name": "get_audit_log_summary_for_your_tenant", "description": "Get audit log summary for your tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "list_api_keys_in_tenant": { "name": "list_api_keys_in_tenant", "description": "List API keys in tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by user ID. The filter intersects with your visibility scope:\nwithout `api-keys:manage`, filtering another user returns an empty\npage (`total: 0`), not an error.\n" }, "enabled": { "anyOf": [ { "$ref": "#/definitions/__schema2" }, { "$ref": "#/definitions/__schema3" } ], "description": "Filter by enabled status. Accepts the strings `true` or `false`." }, "roleId": { "type": "string", "description": "Filter by role ID, or the literal `null` to match keys that inherit\nthe user's roles (no scoped role).\n" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" }, "__schema2": { "type": "boolean", "const": true }, "__schema3": { "type": "boolean", "const": false } } } }, "revoke_an_api_key_admin": { "name": "revoke_an_api_key_admin", "description": "Revoke an API key (Admin)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "keyId": { "type": "string", "description": "API key ID to revoke" } }, "required": [ "keyId" ] } }, "update_rate_limit_override_platform_admin": { "name": "update_rate_limit_override_platform_admin", "description": "Update rate limit override (Platform Admin)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "keyId": { "type": "string", "description": "API key ID to configure" }, "body": { "type": "object", "properties": { "rateLimitEnabled": { "type": "boolean", "description": "Enable or disable rate limiting" }, "rateLimitMax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Max requests per window" }, "rateLimitWindow": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Window size in seconds" } }, "required": [ "rateLimitEnabled" ], "additionalProperties": {} } }, "required": [ "keyId", "body" ] } }, "rotate_an_api_key": { "name": "rotate_an_api_key", "description": "Rotate an API key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "keyId": { "type": "string", "description": "API key ID to rotate" } }, "required": [ "keyId" ] } }, "suspend_or_reactivate_an_api_key": { "name": "suspend_or_reactivate_an_api_key", "description": "Suspend or reactivate an API key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "keyId": { "type": "string", "description": "API key ID to update" }, "body": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Set to true to enable, false to suspend" } }, "required": [ "enabled" ], "additionalProperties": {} } }, "required": [ "keyId", "body" ] } }, "create_an_api_key_for_myself": { "name": "create_an_api_key_for_myself", "description": "Create an API key for myself", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "example": "My CI/CD Key" }, "roleId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Role to assign (null = inherit user's roles; not permitted when the caller is a role-scoped API key)" }, { "type": "null" } ] }, "expiresInDays": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Days until expiration (null = never expires)" }, { "type": "null" } ], "example": 90 }, "metadata": { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Additional metadata to store with the key" } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": {} } } }, "revoke_one_of_my_api_keys": { "name": "revoke_one_of_my_api_keys", "description": "Revoke one of my API keys", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "keyId": { "type": "string", "description": "API key ID to revoke" } }, "required": [ "keyId" ] } }, "get_available_expiration_options": { "name": "get_available_expiration_options", "description": "Get available expiration options", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "get_available_roles_for_api_key_creation": { "name": "get_available_roles_for_api_key_creation", "description": "Get available roles for API key creation", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "sort": { "type": "string", "enum": [ "asc", "desc" ], "description": "Sort order - asc for least privileged first, desc for most privileged first" } } } }, "check_credential_status": { "name": "check_credential_status", "description": "Check Credential Status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "sign_in_with_email": { "name": "sign_in_with_email", "description": "Sign In with Email", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string" }, "rememberMe": { "type": "boolean", "description": "Keep session alive longer" } }, "required": [ "email", "password" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "sign_out": { "name": "sign_out", "description": "Sign Out", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "sso_domain_discovery": { "name": "sso_domain_discovery", "description": "SSO Domain Discovery", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "description": "The email address to check — only the domain part is used" } }, "required": [ "email" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "disable_totp_2_fa": { "name": "disable_totp_2_fa", "description": "Disable TOTP 2FA", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "password": { "type": "string", "description": "Current password to confirm identity" } }, "required": [ "password" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "enable_totp_2_fa": { "name": "enable_totp_2_fa", "description": "Enable TOTP 2FA", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "password": { "type": "string", "description": "Current password to confirm identity" } }, "required": [ "password" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "generate_backup_codes": { "name": "generate_backup_codes", "description": "Generate Backup Codes", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "password": { "type": "string", "description": "Current password to confirm identity" } }, "required": [ "password" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "send_email_otp": { "name": "send_email_otp", "description": "Send Email OTP", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "trustDevice": { "type": "boolean", "description": "Trust this device for 30 days after verification" } }, "additionalProperties": {} } } } }, "get_2_fa_status": { "name": "get_2_fa_status", "description": "Get 2FA Status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "verify_backup_code": { "name": "verify_backup_code", "description": "Verify Backup Code", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "code": { "type": "string", "example": "abc123" }, "trustDevice": { "type": "boolean", "description": "Trust this device for 30 days (skip 2FA on future logins)" } }, "required": [ "code" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "verify_email_otp": { "name": "verify_email_otp", "description": "Verify Email OTP", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "code": { "type": "string", "example": "123456" }, "trustDevice": { "type": "boolean", "description": "Trust this device for 30 days" } }, "required": [ "code" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "verify_totp": { "name": "verify_totp", "description": "Verify TOTP", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "code": { "type": "string", "example": "123456" }, "trustDevice": { "type": "boolean", "description": "Trust this device for 30 days (skip 2FA on future logins)" } }, "required": [ "code" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "check_api_health_status": { "name": "check_api_health_status", "description": "Check API health status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "check_database_health_status": { "name": "check_database_health_status", "description": "Check database health status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "check_remote_api_health_status": { "name": "check_remote_api_health_status", "description": "Check remote API health status", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "get_available_months_with_vm_usage_data": { "name": "get_available_months_with_vm_usage_data", "description": "Get Available Months with VM Usage Data", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the tenant to retrieve available months for" } }, "required": [ "id" ] } }, "get_vm_usage_statistics_by_tenant": { "name": "get_vm_usage_statistics_by_tenant", "description": "Get VM Usage Statistics by Tenant", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the tenant to retrieve usage for" }, "month": { "type": "string", "pattern": "^\\d{4}-(0[1-9]|1[0-2])$", "description": "Month to retrieve usage for in YYYY-MM format. Defaults to current month. Cannot be a future month." } }, "required": [ "id" ] } }, "get_virtual_machines_metrics": { "name": "get_virtual_machines_metrics", "description": "Get Virtual Machines Metrics", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "currentPeriodStart": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "example": "2026-01-01T00:00:00Z", "description": "Current period start date (ISO 8601). Defaults to start of current month." }, "currentPeriodEnd": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "example": "2026-01-09T12:34:56Z", "description": "Current period end date (ISO 8601). Defaults to now." }, "comparisonPeriodStart": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "example": "2025-12-01T00:00:00Z", "description": "Comparison period start date (ISO 8601). Optional." }, "comparisonPeriodEnd": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "example": "2025-12-31T23:59:59Z", "description": "Comparison period end date (ISO 8601). Optional." }, "categories": { "oneOf": [ { "$ref": "#/definitions/__schema0" }, { "$ref": "#/definitions/__schema1" } ], "description": "Filter by category codes. Can be single value or array." }, "datacenters": { "oneOf": [ { "$ref": "#/definitions/__schema2" }, { "$ref": "#/definitions/__schema3" } ], "description": "Filter by datacenter IDs. Can be single value or array." }, "includeVmNames": { "default": false, "description": "Include individual VM names in response (impacts performance). Default false.", "allOf": [ { "$ref": "#/definitions/__schema4" } ] } }, "definitions": { "__schema0": { "type": "string", "example": "general" }, "__schema1": { "type": "array", "items": { "type": "string" }, "example": [ "general", "gpu" ] }, "__schema2": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "7e957d78-88dd-4eee-a712-0ca8b9a482e7" }, "__schema3": { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "__schema4": { "type": "boolean" } } } }, "list_custom_images": { "name": "list_custom_images", "description": "List custom images", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term (searches by image name and description)" }, "filter[datacenterId]": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by datacenter ID (UUID)" }, "filter[active]": { "type": "boolean", "description": "Filter by active status" }, "filter[imageType]": { "type": "string", "enum": [ "template", "iso" ], "description": "Filter by image type" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "initiate_a_custom_image_upload": { "name": "initiate_a_custom_image_upload", "description": "Initiate a custom image upload", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80, "example": "My VM template" }, "description": { "type": "string", "maxLength": 500 }, "imageType": { "type": "string", "enum": [ "template", "iso" ] }, "osFamily": { "type": "string", "enum": [ "linux", "windows", "other" ] }, "filename": { "type": "string", "maxLength": 512, "example": "ubuntu-2404.qcow2" }, "contentLength": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "File size in bytes. Capped at the configured maximum (default 50 GiB)." }, "uefi": { "default": true, "type": "boolean", "description": "Firmware: `true` = UEFI with secure boot, `false` = legacy BIOS.\nOptional — defaults to `true` when omitted. The image owner can\nchange it later via PATCH.\n" } }, "required": [ "name", "imageType", "osFamily", "filename", "contentLength" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_delete_custom_images": { "name": "bulk_delete_custom_images", "description": "Bulk Delete Custom Images", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_edit_custom_images": { "name": "bulk_edit_custom_images", "description": "Bulk Edit Custom Images", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "data": { "type": "object", "properties": { "active": { "$ref": "#/definitions/__schema1" }, "config": { "$ref": "#/definitions/__schema2" }, "networkHotplug": { "$ref": "#/definitions/__schema3" } }, "additionalProperties": { "$ref": "#/definitions/__schema4" }, "description": "Only operational fields that make sense applied to multiple images at once" } }, "required": [ "ids", "data" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema1": { "type": "boolean" }, "__schema2": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cloud-init", "none" ] } }, "additionalProperties": {} }, "__schema3": { "type": "boolean" }, "__schema4": {} } } }, "delete_custom_image": { "name": "delete_custom_image", "description": "Delete custom image", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID" } }, "required": [ "id" ] } }, "get_custom_image": { "name": "get_custom_image", "description": "Get custom image", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID" } }, "required": [ "id" ] } }, "update_custom_image": { "name": "update_custom_image", "description": "Update custom image", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80, "description": "Display name for the image" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500, "description": "Optional description" }, { "type": "null" } ] }, "active": { "type": "boolean", "description": "Whether the image is active and available for use" }, "config": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": { "$ref": "#/definitions/__schema0" }, "description": "Image configuration" }, { "type": "null" } ] }, "username": { "type": "string", "maxLength": 20, "description": "Default login username for cloud-init provisioning" }, "uefi": { "type": "boolean", "description": "UEFI with secure boot (true) or legacy BIOS (false). Only the image owner can modify this. Changes apply to future VMs." }, "networkHotplug": { "type": "boolean", "description": "Whether the image supports network hotplug" } }, "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": {} } } }, "finalize_a_multipart_upload": { "name": "finalize_a_multipart_upload", "description": "Finalize a multipart upload", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "parts": { "minItems": 1, "maxItems": 10000, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "parts" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "partNumber": { "type": "integer", "minimum": 1, "maximum": 10000 }, "etag": { "type": "string", "description": "ETag returned in the response header of each part upload." } }, "required": [ "partNumber", "etag" ], "additionalProperties": {} } } } }, "list_a_custom_image_s_deployments": { "name": "list_a_custom_image_s_deployments", "description": "List a custom image's deployments", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID." } }, "required": [ "id" ] } }, "deploy_a_staged_custom_image_to_one_or_more_datacenters": { "name": "deploy_a_staged_custom_image_to_one_or_more_datacenters", "description": "Deploy a staged custom image to one or more datacenters", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID." }, "body": { "type": "object", "properties": { "datacenterIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "One or more datacenter UUIDs to deploy this staged image to.\nThe image is deployed to each datacenter independently — if one\ndatacenter can't be started it appears under `failures` while the\nrest proceed. Track per-datacenter progress via\n`GET /resource/custom-images/{id}/deployments`.\n" } }, "required": [ "datacenterIds" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "delete_a_single_deployment_of_a_custom_image": { "name": "delete_a_single_deployment_of_a_custom_image", "description": "Delete a single deployment of a custom image", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Custom image ID." }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Datacenter from which to remove this image." } }, "required": [ "id", "datacenterId" ] } }, "re_issue_presigned_urls_for_specific_parts": { "name": "re_issue_presigned_urls_for_specific_parts", "description": "Re-issue presigned URLs for specific parts", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "partNumbers": { "minItems": 1, "maxItems": 10000, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "partNumbers" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 10000 } } } }, "list_all_data_centers": { "name": "list_all_data_centers", "description": "List All Data Centers", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "sort": { "default": "name:asc", "description": "Sort field and direction. Supports comma-separated values for multi-column sorting.\nAvailable fields: name, regionName, countryName\n", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "regionId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Filter data centers by region ID" }, "countryId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter data centers by country ID (UUID)" }, "countryName": { "type": "string", "description": "Filter data centers by exact country name" }, "regionName": { "type": "string", "description": "Filter data centers by exact region name" }, "gpuEnabled": { "type": "boolean", "description": "Filter data centers by GPU capability. Use 'true' for GPU-enabled data centers only, 'false' for non-GPU data centers only." }, "vpcCapable": { "type": "boolean", "description": "Filter data centers by VPC networking availability. Use 'true' for data centers that currently offer VPC networking, 'false' for those that do not." }, "l2Capable": { "type": "boolean", "description": "Filter data centers by L2 segment support. Use 'true' for data centers that support L2 segments, 'false' for those that do not." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "list_all_virtual_machine_images_available_in_a_data_center": { "name": "list_all_virtual_machine_images_available_in_a_data_center", "description": "List All Virtual Machine Images Available In A Data Center", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The data center ID to list images from" } }, "required": [ "id" ] } }, "list_virtual_machine_sizes_for_a_data_center": { "name": "list_virtual_machine_sizes_for_a_data_center", "description": "List Virtual Machine Sizes for a Data Center", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The data center ID to retrieve sizes for" }, "vmId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "When provided, the response is filtered to upgrade-only sizes\nfor the specified VM (CPU/RAM/disk >= current) and the VM's\ncurrent SKU is excluded. The response shape is the same as the\ncatalog-browse path (`VmSizeCatalogResponse`).\n" }, "categoryCode": { "type": "string", "description": "Accepted for backward compatibility but no longer honored.\nOlder clients can continue sending this query param without\ntriggering a 400.\n" }, "tierCode": { "type": "string", "description": "Accepted for backward compatibility but no longer honored.\nOlder clients can continue sending this query param without\ntriggering a 400.\n" } }, "required": [ "id" ] } }, "list_all_volume_sizes_available_in_a_data_center": { "name": "list_all_volume_sizes_available_in_a_data_center", "description": "List All Volume Sizes Available In A Data Center", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The data center ID to retrieve volume sizes for" } }, "required": [ "id" ] } }, "list_gpu_vms": { "name": "list_gpu_vms", "description": "List GPU VMs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term (searches in GPU VM name)" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by resource group ID" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_gpu_vm": { "name": "create_a_gpu_vm", "description": "Create a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$", "example": "GPU Trainer 1" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID to assign the VM to" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Datacenter/region ID (from /series endpoint availability)" }, "seriesId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "GPU series ID (from /series endpoint)" }, "gpuCount": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 2 }, { "type": "number", "const": 4 }, { "type": "number", "const": 8 } ] }, "sshKeyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key library UUID — the public key will be uploaded to the provider. Use GET /resource/ssh-keys to list available keys." }, "username": { "type": "string", "description": "Optional OS username for SSH access. If omitted, the image default username is used." }, "skuCode": { "type": "string", "description": "Optional explicit platform SKU catalog code (inventory availableSkus[].skuCode). The provider offering code is also accepted. If omitted, the cheapest available SKU is auto-selected." }, "imageName": { "type": "string", "description": "OS image name. Defaults to ubuntu-24.04 if not specified. Available options - ubuntu-22.04, ubuntu-24.04." }, "imageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "OS image UUID (alternative to imageName). If both are provided, imageName takes priority." } }, "required": [ "name", "datacenterId", "seriesId", "gpuCount", "sshKeyId" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_delete_gpu_vms": { "name": "bulk_delete_gpu_vms", "description": "Bulk delete GPU VMs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_reset_gpu_vms": { "name": "bulk_reset_gpu_vms", "description": "Bulk reset GPU VMs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_start_gpu_vms": { "name": "bulk_start_gpu_vms", "description": "Bulk start GPU VMs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_stop_gpu_vms": { "name": "bulk_stop_gpu_vms", "description": "Bulk stop GPU VMs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "delete_a_gpu_vm": { "name": "delete_a_gpu_vm", "description": "Delete a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "get_gpu_vm_details": { "name": "get_gpu_vm_details", "description": "Get GPU VM details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "update_a_gpu_vm": { "name": "update_a_gpu_vm", "description": "Update a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$", "example": "GPU Trainer 1" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID to assign the VM to" }, "sshKeyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID to associate with the VM, or null to clear the association" }, { "type": "null" } ] }, "username": { "type": "string", "minLength": 3, "maxLength": 20, "pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*$", "description": "Username for SSH access (must start with a letter or underscore)" } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_audit_events_for_a_gpu_vm": { "name": "list_audit_events_for_a_gpu_vm", "description": "List audit events for a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "GPU VM UUID" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "description": "Page number (1-indexed)" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Items per page" }, "occurredAfter": { "type": "string", "description": "Lower bound on `occurredAt`, inclusive. ISO-8601 timestamp or date-only (`2026-03-01`)." }, "occurredBefore": { "type": "string", "description": "Upper bound on `occurredAt`, inclusive. A date-only value is promoted to the end of that day, so `2026-03-15` includes events recorded during 2026-03-15." } }, "required": [ "id" ] } }, "reset_a_gpu_vm": { "name": "reset_a_gpu_vm", "description": "Reset a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "get_ssh_private_key_legacy": { "name": "get_ssh_private_key_legacy", "description": "Get SSH private key (legacy)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "start_a_gpu_vm": { "name": "start_a_gpu_vm", "description": "Start a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "stop_a_gpu_vm": { "name": "stop_a_gpu_vm", "description": "Stop a GPU VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The GPU VM ID" } }, "required": [ "id" ] } }, "get_gpu_inventory_with_real_time_availability": { "name": "get_gpu_inventory_with_real_time_availability", "description": "Get GPU inventory with real-time availability", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "code": { "type": "string", "description": "Filter by series code (e.g., \"h100_series\")" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by datacenter ID" }, "count": { "anyOf": [ { "$ref": "#/definitions/__schema0" }, { "$ref": "#/definitions/__schema1" }, { "$ref": "#/definitions/__schema2" }, { "$ref": "#/definitions/__schema3" } ], "description": "Filter by GPU count" } }, "definitions": { "__schema0": { "type": "number", "const": 1 }, "__schema1": { "type": "number", "const": 2 }, "__schema2": { "type": "number", "const": 4 }, "__schema3": { "type": "number", "const": 8 } } } }, "list_all_resource_groups": { "name": "list_all_resource_groups", "description": "List all resource groups", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "search": { "type": "string", "description": "Search term to filter resource groups by name" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter resource groups by tenant ID" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_new_resource_group": { "name": "create_a_new_resource_group", "description": "Create a new resource group", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "description": "The name of the new resource group" }, "description": { "type": "string", "maxLength": 255, "description": "Optional description for the resource group" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Tenant ID (defaults to your tenant). Requires hierarchy access to target tenant." } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_add_members_to_resource_groups": { "name": "bulk_add_members_to_resource_groups", "description": "Bulk add members to resource groups", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "userIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "User IDs to add to resource groups" }, "resourceGroupIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Resource group IDs to add users to" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional tenant ID for cross-tenant access. If omitted, defaults to your tenant." } }, "required": [ "userIds", "resourceGroupIds" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "bulk_delete_resource_groups": { "name": "bulk_delete_resource_groups", "description": "Bulk delete resource groups", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Resource group IDs to delete" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional tenant ID for cross-tenant access. If omitted, defaults to your tenant." } }, "required": [ "ids" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "delete_a_resource_group": { "name": "delete_a_resource_group", "description": "Delete a resource group", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional tenant ID for cross-tenant access. If omitted, defaults to your tenant. Requires hierarchy access." } }, "required": [ "id" ] } }, "get_resource_group_details_with_members": { "name": "get_resource_group_details_with_members", "description": "Get resource group details with members", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter members by name or email" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional tenant ID for cross-tenant access. If omitted, defaults to your tenant. Requires hierarchy access." } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "update_resource_group_details": { "name": "update_resource_group_details", "description": "Update resource group details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "description": "The new name of the resource group" }, "description": { "type": "string", "maxLength": 255, "description": "The new description for the resource group" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional tenant ID for cross-tenant access. If omitted, defaults to your tenant. Requires hierarchy access." } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "add_user_to_resource_group": { "name": "add_user_to_resource_group", "description": "Add user to resource group", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID" }, "body": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the user to be added to the resource group" } }, "required": [ "userId" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "remove_user_from_resource_group": { "name": "remove_user_from_resource_group", "description": "Remove user from resource group", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group ID" }, "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" } }, "required": [ "id", "userId" ] } }, "get_resource_job_progress": { "name": "get_resource_job_progress", "description": "Get Resource Job Progress", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "jobIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Array of job UUIDs (1-50 jobs)" } }, "required": [ "jobIds" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "list_l2_segments": { "name": "list_l2_segments", "description": "List L2 segments", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Restrict the list to one data center." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_an_l2_segment": { "name": "create_an_l2_segment", "description": "Create an L2 segment", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "description": { "type": "string", "maxLength": 500 }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "name", "datacenterId" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "delete_an_l2_segment": { "name": "delete_an_l2_segment", "description": "Delete an L2 segment", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "get_an_l2_segment": { "name": "get_an_l2_segment", "description": "Get an L2 segment", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "rename_or_re_describe_an_l2_segment": { "name": "rename_or_re_describe_an_l2_segment", "description": "Rename or re-describe an L2 segment", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_the_interfaces_attached_to_an_l2_segment": { "name": "list_the_interfaces_attached_to_an_l2_segment", "description": "List the interfaces attached to an L2 segment", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sortable fields: virtualMachineName, networkInterface, createdAt.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "list_networks": { "name": "list_networks", "description": "List Networks", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "filter[regionId]": { "type": "string", "pattern": "^\\d+(,\\d+)*$", "description": "Filter by region ID (supports comma-separated values for multiple regions)" }, "filter[datacenterId]": { "type": "string", "description": "Filter by data center ID (supports comma-separated UUIDs for multiple data centers)" }, "filter[networkType]": { "type": "string", "enum": [ "standard", "custom" ], "description": "Filter by network type" }, "filter[resourceGroupId]": { "type": "string", "description": "Filter by resource group ID (supports comma-separated UUIDs for multiple resource groups)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_network": { "name": "create_network", "description": "Create Network", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the network" }, "description": { "type": "string", "description": "The description of the network" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "550e8400-e29b-41d4-a716-446655440000" }, "cidrBlock": { "type": "string", "description": "The CIDR block of the network. Required for standard networks." }, "snatEnabled": { "type": "boolean", "description": "Whether SNAT is enabled for the network" }, "dhcpServerEnabled": { "type": "boolean", "description": "Whether DHCP is enabled for the network" }, "dhcpStartAddress": { "type": "string", "description": "The start address of the DHCP range" }, "dhcpEndAddress": { "type": "string", "description": "The end address of the DHCP range" }, "defaultRouteEnabled": { "type": "boolean", "description": "Whether the default route is enabled for the network" }, "defaultRoute": { "type": "string", "description": "The default route (gateway IP) of the network. Required for standard networks; must fall inside cidrBlock." }, "serveDNSServersEnabled": { "type": "boolean", "description": "Whether DNS servers are enabled for the network" }, "dnsServers": { "type": "string", "description": "The DNS servers of the network" }, "networkType": { "type": "string", "const": "standard" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The resource group to assign this network to (optional)" } }, "required": [ "name", "datacenterId", "snatEnabled", "networkType" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_delete_networks": { "name": "bulk_delete_networks", "description": "Bulk Delete Networks", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "get_cidr_details": { "name": "get_cidr_details", "description": "Get CIDR Details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "cidr": { "type": "string", "description": "The CIDR block to validate and get details for (e.g., \"192.168.1.0/24\")" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional data center ID parameter (accepted for API compatibility).\n**Note**: This parameter is not used in CIDR calculation. CIDR allocation is tenant-wide, not data-center-specific.\n" } } } }, "delete_network": { "name": "delete_network", "description": "Delete Network", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the network to delete" } }, "required": [ "id" ] } }, "get_network_details": { "name": "get_network_details", "description": "Get Network Details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the network to retrieve" } }, "required": [ "id" ] } }, "update_network": { "name": "update_network", "description": "Update Network", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the network to update" }, "body": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the network" }, "description": { "type": "string", "description": "The description of the network" }, "cidrBlock": { "type": "string", "description": "The CIDR block of the network" }, "dhcpServerEnabled": { "type": "boolean", "description": "Whether DHCP is enabled for the network" }, "dhcpStartAddress": { "type": "string", "description": "The start address of the DHCP range" }, "dhcpEndAddress": { "type": "string", "description": "The end address of the DHCP range" }, "defaultRouteEnabled": { "type": "boolean", "description": "Whether the default route is enabled for the network" }, "defaultRoute": { "type": "string", "description": "The default route (gateway IP) of the network. Required whenever cidrBlock is sent or networkType is standard; must fall inside cidrBlock." }, "serveDNSServersEnabled": { "type": "boolean", "description": "Whether DNS servers are enabled for the network" }, "dnsServers": { "type": "string", "description": "The DNS servers of the network" }, "networkType": { "type": "string", "enum": [ "standard", "custom" ] }, "resourceGroupId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The resource group to assign this network to (null to unassign)" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_audit_events_for_a_network": { "name": "list_audit_events_for_a_network", "description": "List audit events for a network", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Network UUID" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "description": "Page number (1-indexed)" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Items per page" }, "occurredAfter": { "type": "string", "description": "Lower bound on `occurredAt`, inclusive. ISO-8601 timestamp or date-only (`2026-03-01`)." }, "occurredBefore": { "type": "string", "description": "Upper bound on `occurredAt`, inclusive. A date-only value is promoted to the end of that day, so `2026-03-15` includes events recorded during 2026-03-15." } }, "required": [ "id" ] } }, "get_vms_for_network": { "name": "get_vms_for_network", "description": "Get VMs for Network", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the network to retrieve" } }, "required": [ "id" ] } }, "list_ssh_keys": { "name": "list_ssh_keys", "description": "List SSH keys", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term (searches by key name)" }, "filter[algorithm]": { "type": "string", "example": "ed25519", "description": "Filter by algorithm code (e.g. 'ed25519', 'rsa-4096')" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_ssh_key": { "name": "create_ssh_key", "description": "Create SSH key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "generate" }, "name": { "type": "string", "minLength": 1, "maxLength": 30, "description": "Display name, 1 to 30 characters. Allows letters, numbers, spaces, and a few label symbols (period, hyphen, underscore, parentheses, apostrophe, hash); must begin and end with a letter or number. Must be unique within the entity (case-insensitive)." }, "algorithm": { "type": "string", "example": "rsa-4096" }, "passphrase": { "type": "string", "minLength": 1, "maxLength": 128, "description": "Optional passphrase to encrypt the private key. When provided, the returned private key will be passphrase-protected in OpenSSH format." } }, "required": [ "type", "name", "algorithm" ], "additionalProperties": {}, "title": "Generate" }, { "type": "object", "properties": { "type": { "$ref": "#/definitions/__schema0" }, "name": { "$ref": "#/definitions/__schema1" }, "publicKey": { "$ref": "#/definitions/__schema2" } }, "required": [ "type", "name", "publicKey" ], "additionalProperties": { "$ref": "#/definitions/__schema3" }, "title": "Upload" } ] } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "const": "upload" }, "__schema1": { "type": "string", "minLength": 1, "maxLength": 30, "description": "Display name, 1 to 30 characters. Allows letters, numbers, spaces, and a few label symbols (period, hyphen, underscore, parentheses, apostrophe, hash); must begin and end with a letter or number. Must be unique within the entity (case-insensitive)." }, "__schema2": { "type": "string", "description": "Public key in OpenSSH format (e.g. \"ssh-ed25519 AAAA...\")" }, "__schema3": {} } } }, "list_supported_ssh_key_algorithms": { "name": "list_supported_ssh_key_algorithms", "description": "List supported SSH key algorithms", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "bulk_delete_ssh_keys": { "name": "bulk_delete_ssh_keys", "description": "Bulk delete SSH keys", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "delete_ssh_key": { "name": "delete_ssh_key", "description": "Delete SSH key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID" } }, "required": [ "id" ] } }, "get_ssh_key": { "name": "get_ssh_key", "description": "Get SSH key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID" } }, "required": [ "id" ] } }, "manage_ssh_key": { "name": "manage_ssh_key", "description": "Manage SSH key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID" }, "body": { "type": "object", "properties": { "isDefault": { "type": "boolean", "description": "Set this key as the tenant default (clears any existing default)" }, "vmIds": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "VM IDs to associate with this SSH key" } }, "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "rename_ssh_key": { "name": "rename_ssh_key", "description": "Rename SSH key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 30, "description": "Display name, 1 to 30 characters. Allows letters, numbers, spaces, and a few label symbols (period, hyphen, underscore, parentheses, apostrophe, hash); must begin and end with a letter or number. Must be unique within the entity (case-insensitive)." } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "get_paginated_list_of_virtual_machines": { "name": "get_paginated_list_of_virtual_machines", "description": "Get paginated list of virtual machines", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term (searches in VM name, primary public IP, and primary private IP)" }, "filter[resourceGroupId]": { "type": "string", "description": "Filter by resource group ID (supports comma-separated UUIDs for OR filtering)" }, "filter[regionId]": { "type": "string", "description": "Filter by region ID (supports comma-separated values for OR filtering)" }, "filter[datacenterId]": { "type": "string", "description": "Filter by data center ID (supports comma-separated UUIDs for OR filtering)" }, "filter[skuCatalogId]": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by SKU catalog ID (UUID, supports comma-separated values for OR filtering).\n" }, "filter[imageName]": { "type": "string", "description": "Filter by image name (supports comma-separated values for OR filtering, e.g., \"Ubuntu 24.04,Debian 12\")" }, "filter[status]": { "type": "string", "description": "Filter by VM status (supports comma-separated values for OR filtering, e.g., \"Running,Stopped\")" }, "filter[vpcId]": { "type": "string", "description": "Filter by VPC membership - machines holding at least one live interface on a subnet of the VPC (supports comma-separated UUIDs for OR filtering)" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_new_virtual_machine": { "name": "create_a_new_virtual_machine", "description": "Create a new virtual machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "ID of the data center where VMs will be created. The backend automatically selects the appropriate cloud provider based on data center." }, "imageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "UUID of the OS image to use" }, "skuId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "UUID of the VM SKU (from `GET /resource/data-centers/{id}/virtual-machine-sizes`).\n" }, "name": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$", "example": "Web Server v1.2" }, "hostname": { "type": "string", "minLength": 1, "maxLength": 60, "pattern": "^[a-zA-Z]([a-zA-Z0-9-]*[a-zA-Z0-9])?$", "example": "web-server-1" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional resource group ID to assign VMs to" }, "numberOfInstances": { "default": 1, "type": "number", "minimum": 1, "maximum": 10, "description": "Number of VMs to create (default 1, max 10)" }, "acquirePublicIp": { "default": false, "type": "boolean", "description": "Ask the platform for a new public address on the primary interface. On a VPC-shaped body it acquires one elastic address into the VPC's holdings on that VPC's anchor and attaches it to the interface — one address, which is why it cannot be combined with more than one instance. On a legacy body it allocates one address per instance onto each machine's own NIC, and is only supported on standard networks, not custom L2 ones. Mutually exclusive with publicIpId.\n" }, "publicIpId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "A HELD VPC elastic address to attach to the primary interface. Requires a VPC subnet interface, and the address must belong to that subnet's VPC — an address of any other VPC, like an unknown id, answers 404 \"Public IP not found\". Mutually exclusive with acquirePublicIp.\n" }, "networkId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The one legacy network the machine is born on. Mutually exclusive with `subnetId`;\nomit both and the data center's default network for the entity is created/used automatically.\n\nMust be in the same data center as the VM, and if `acquirePublicIp` is true it must be a\nstandard (L3) network. Additional interfaces are added after creation through the\nnetwork-interface attach endpoint.\n" }, "subnetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The one VPC subnet the machine is born on. Mutually exclusive with `networkId`.\n\nRequires the `vpc` feature and a VPC-capable data center; the subnet must be `ready` and sit in\nthe VM's data center. Public addressing here is the elastic surface: `acquirePublicIp` acquires\na new address, `publicIpId` takes one already held.\n" }, "authMethod": { "type": "string", "enum": [ "ssh-key", "password", "custom" ] }, "sshKeyId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key library UUID to use for authentication.\nRequired when `authMethod` is `ssh-key`. Use `GET /resource/ssh-keys` to list available keys.\n" }, "password": { "type": "string", "minLength": 12, "maxLength": 20, "pattern": "^[A-Za-z0-9!@#%\\-_.]+$", "description": "VM admin password. Required when `authMethod` is `password`.\nMust be 12–20 characters and contain at least one uppercase letter, one lowercase letter,\none digit, and one special character. Allowed special characters: `! @ # % - _ .`\nThe password is passed to the provisioning system and never stored server-side.\n" }, "username": { "type": "string", "minLength": 3, "maxLength": 20, "example": "myuser" } }, "required": [ "datacenterId", "imageId", "skuId", "name" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_delete_virtual_machines": { "name": "bulk_delete_virtual_machines", "description": "Bulk Delete Virtual Machines", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_reset_virtual_machines": { "name": "bulk_reset_virtual_machines", "description": "Bulk Reset Virtual Machines", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_start_virtual_machines": { "name": "bulk_start_virtual_machines", "description": "Bulk Start Virtual Machines", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_stop_virtual_machines": { "name": "bulk_stop_virtual_machines", "description": "Bulk Stop Virtual Machines", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "delete_virtual_machine": { "name": "delete_virtual_machine", "description": "Delete Virtual Machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine to delete" }, "body": { "type": "object", "properties": { "releasePublicIps": { "default": false, "type": "boolean", "description": "Destroy the machine's VPC elastic public IPs instead of returning them to holdings" } }, "additionalProperties": false } }, "required": [ "id" ] } }, "get_virtual_machine_details": { "name": "get_virtual_machine_details", "description": "Get Virtual Machine Details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which to get the virtual machine" } }, "required": [ "id" ] } }, "edit_virtual_machine": { "name": "edit_virtual_machine", "description": "Edit Virtual Machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine to edit" }, "body": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$", "example": "Web Server v1.2" }, "resourceGroupId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "New resource group for the virtual machine" }, { "type": "null" } ] }, "sshKeyId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "SSH key ID to associate with the VM, or null to clear the association" }, { "type": "null" } ] }, "username": { "type": "string", "minLength": 3, "maxLength": 20, "pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*$", "description": "Username for SSH access (must start with a letter or underscore)" } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "get_available_networks_for_vm": { "name": "get_available_networks_for_vm", "description": "Get Available Networks for VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" } }, "required": [ "id" ] } }, "get_vm_console_url": { "name": "get_vm_console_url", "description": "Get VM Console URL", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The internal ID of the virtual machine" } }, "required": [ "id" ] } }, "list_audit_events_for_a_virtual_machine": { "name": "list_audit_events_for_a_virtual_machine", "description": "List audit events for a virtual machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Virtual machine UUID" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "description": "Page number (1-indexed)" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Items per page" }, "occurredAfter": { "type": "string", "description": "Lower bound on `occurredAt`, inclusive. ISO-8601 timestamp or date-only (`2026-03-01`)." }, "occurredBefore": { "type": "string", "description": "Upper bound on `occurredAt`, inclusive. A date-only value is promoted to the end of that day, so `2026-03-15` includes events recorded during 2026-03-15." } }, "required": [ "id" ] } }, "list_network_interfaces_for_vm": { "name": "list_network_interfaces_for_vm", "description": "List Network Interfaces for VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" } }, "required": [ "id" ] } }, "add_network_interface_to_vm": { "name": "add_network_interface_to_vm", "description": "Add Network Interface to VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "body": { "type": "object", "properties": { "networkId": { "$ref": "#/definitions/__schema0" }, "subnetId": { "$ref": "#/definitions/__schema1" }, "l2SegmentId": { "$ref": "#/definitions/__schema2" } }, "additionalProperties": { "$ref": "#/definitions/__schema3" }, "description": "Names exactly one target: `networkId` for a network, `subnetId` for a VPC subnet, `l2SegmentId` for an L2 segment. A body carrying more than one, or none, is rejected. A VM attached to networks cannot take a subnet interface, and a VM already in a VPC can only take subnets of that same VPC (422). An L2 segment belongs to neither world and is attachable to a VM of either, whatever its L3 interfaces are.\n" } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the network to attach. Mutually exclusive with `subnetId` and `l2SegmentId`." }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the VPC subnet to attach. Mutually exclusive with `networkId` and `l2SegmentId`." }, "__schema2": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the L2 segment to attach. Mutually exclusive with the other two. The segment must be `ready` and in the virtual machine's own data center; the interface is never primary and carries no address, because a segment has no subnet, gateway or DHCP.\n" }, "__schema3": {} } } }, "remove_network_interface_from_vm": { "name": "remove_network_interface_from_vm", "description": "Remove Network Interface from VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "networkInterfaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the network interface to remove" }, "body": { "type": "object", "properties": { "releasePublicIps": { "default": false, "type": "boolean", "description": "Destroy the interface's VPC elastic public IPs instead of returning them to holdings" } }, "additionalProperties": false } }, "required": [ "id", "networkInterfaceId" ] } }, "get_a_single_network_interface_for_vm": { "name": "get_a_single_network_interface_for_vm", "description": "Get a Single Network Interface for VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "networkInterfaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the network interface" } }, "required": [ "id", "networkInterfaceId" ] } }, "update_network_interface": { "name": "update_network_interface", "description": "Update Network Interface", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "networkInterfaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the network interface to update" }, "body": { "type": "object", "properties": { "setPrimary": { "type": "boolean", "example": true } }, "additionalProperties": {} } }, "required": [ "id", "networkInterfaceId", "body" ] } }, "release_public_ip_from_network_interface": { "name": "release_public_ip_from_network_interface", "description": "Release Public IP from Network Interface", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "networkInterfaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the network interface to release the public IP from" } }, "required": [ "id", "networkInterfaceId" ] } }, "allocate_public_ip_to_network_interface": { "name": "allocate_public_ip_to_network_interface", "description": "Allocate Public IP to Network Interface", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id of the virtual machine" }, "networkInterfaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The UUID of the network interface to allocate a public IP to" } }, "required": [ "id", "networkInterfaceId" ] } }, "get_virtual_machine_password": { "name": "get_virtual_machine_password", "description": "Get Virtual Machine Password", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine you want to access" } }, "required": [ "id" ] } }, "exit_rescue_mode": { "name": "exit_rescue_mode", "description": "Exit Rescue Mode", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Virtual machine ID" } }, "required": [ "id" ] } }, "get_vm_rescue_state": { "name": "get_vm_rescue_state", "description": "Get VM Rescue State", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Virtual machine ID" } }, "required": [ "id" ] } }, "enter_rescue_mode": { "name": "enter_rescue_mode", "description": "Enter Rescue Mode", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Virtual machine ID" }, "body": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "catalog", "custom" ] }, "sourceImageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "ID of the catalog or custom ISO image" } }, "required": [ "sourceType", "sourceImageId" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "reset_virtual_machine": { "name": "reset_virtual_machine", "description": "Reset Virtual Machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine to reset" } }, "required": [ "id" ] } }, "change_virtual_machine_size": { "name": "change_virtual_machine_size", "description": "Change Virtual Machine Size", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine you want to update" }, "body": { "type": "object", "properties": { "skuId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "required": [ "skuId" ], "additionalProperties": false } }, "required": [ "id", "body" ] } }, "get_virtual_machine_ssh_key": { "name": "get_virtual_machine_ssh_key", "description": "Get Virtual Machine SSH Key", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine you want to access" } }, "required": [ "id" ] } }, "start_virtual_machine": { "name": "start_virtual_machine", "description": "Start Virtual Machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine to start" } }, "required": [ "id" ] } }, "stop_virtual_machine": { "name": "stop_virtual_machine", "description": "Stop Virtual Machine", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The id for which virtual machine to stop" } }, "required": [ "id" ] } }, "list_volumes": { "name": "list_volumes", "description": "List Volumes", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "type": "string", "example": "createdAt:desc", "description": "Sort order as \"field:direction\". Supports comma-separated multi-column sorting.\nAvailable fields: name, status, createdAt, virtualMachineName, regionName, volumeTypeCode, sizeGb\nDirection: asc or desc\n" }, "search": { "type": "string", "description": "Search term to filter results (searches: name, virtualMachineName)" }, "filter[virtualMachineId]": { "type": "string", "description": "Filter by attached VM ID (single or comma-separated for multiple)" }, "filter[projectId]": { "type": "string", "description": "Filter by project ID (single or comma-separated for multiple)" }, "filter[resourceGroupId]": { "type": "string", "description": "Filter by resource group ID (single or comma-separated UUIDs for multiple)" }, "filter[status]": { "type": "string", "description": "Filter by status (single or comma-separated for multiple)" }, "filter[regionId]": { "type": "string", "description": "Filter by region ID (single or comma-separated for multiple)" }, "filter[datacenterId]": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter by datacenter ID (single UUID or comma-separated UUIDs)" }, "filter[manageableForVm]": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Storage-management view for a VM: restrict to volumes that are either available (attachable) or attached to this VM (detachable). Pair with filter[datacenterId] to scope to the VM's location." }, "filter[volumeTypeCode]": { "type": "string", "description": "Filter by storage class — the volume SKU's storage component code (e.g. vol-add-ssd, vol-add-nvme), matching componentCode on the volume-sizes endpoint. Single value or comma-separated." }, "filter[sizeGb]": { "type": "string", "description": "Filter by size in GB (single or comma-separated for multiple, e.g., \"256,512,1024\")" } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "create_volume": { "name": "create_volume", "description": "Create Volume", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "example": "My Data Volume" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "550e8400-e29b-41d4-a716-446655440000" }, "skuId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "550e8400-e29b-41d4-a716-446655440001" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "550e8400-e29b-41d4-a716-446655440000" } }, "required": [ "name", "datacenterId", "skuId" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "bulk_delete_volumes": { "name": "bulk_delete_volumes", "description": "Bulk Delete Volumes", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "bulk_detach_volumes": { "name": "bulk_detach_volumes", "description": "Bulk Detach Volumes", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "$ref": "#/definitions/__schema0" } }, "required": [ "ids" ], "additionalProperties": { "$ref": "#/definitions/__schema2" }, "description": "Request body for bulk operations with UUID-based IDs" } }, "required": [ "body" ], "definitions": { "__schema0": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "example": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ] }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema2": {} } } }, "delete_volume": { "name": "delete_volume", "description": "Delete Volume", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" } }, "required": [ "id" ] } }, "get_volume_details": { "name": "get_volume_details", "description": "Get Volume Details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" } }, "required": [ "id" ] } }, "attach_volume_to_vm": { "name": "attach_volume_to_vm", "description": "Attach Volume to VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" }, "body": { "type": "object", "properties": { "virtualMachineId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "example": "123e4567-e89b-12d3-a456-426655440000" } }, "required": [ "virtualMachineId" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "get_available_virtual_machines_for_volume": { "name": "get_available_virtual_machines_for_volume", "description": "Get Available Virtual Machines for Volume", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" } }, "required": [ "id" ] } }, "detach_volume_from_vm": { "name": "detach_volume_from_vm", "description": "Detach Volume from VM", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" } }, "required": [ "id" ] } }, "list_audit_events_for_a_volume": { "name": "list_audit_events_for_a_volume", "description": "List audit events for a volume", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Volume UUID" }, "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "description": "Page number (1-indexed)" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200, "description": "Items per page" }, "occurredAfter": { "type": "string", "description": "Lower bound on `occurredAt`, inclusive. ISO-8601 timestamp or date-only (`2026-03-01`)." }, "occurredBefore": { "type": "string", "description": "Upper bound on `occurredAt`, inclusive. A date-only value is promoted to the end of that day, so `2026-03-15` includes events recorded during 2026-03-15." } }, "required": [ "id" ] } }, "resize_volume": { "name": "resize_volume", "description": "Resize Volume", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The volume UUID" }, "body": { "type": "object", "properties": { "newSizeGb": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "example": 1024 } }, "required": [ "newSizeGb" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_vpcs": { "name": "list_vpcs", "description": "List VPCs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Only VPCs in this data center." }, "status": { "type": "string", "enum": [ "creating", "active", "failed", "deleting" ], "description": "Only VPCs in this lifecycle state." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_vpc": { "name": "create_a_vpc", "description": "Create a VPC", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "cidr": { "type": "string", "example": "10.50.0.0/16" }, "datacenterId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The one data center this VPC lives in. Immutable — the update endpoint rejects this field." }, "description": { "type": "string", "maxLength": 500 }, "dnsNameservers": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "One or two IPv4 resolver addresses for this VPC's guests, in order of preference. Plain IPv4 addresses only — no hostnames, ports or CIDR notation; 0.0.0.0, loopback, multicast and broadcast addresses are refused, and the two must differ. Private (RFC1918) resolvers are allowed. Omit to use the platform default. Immutable after create — the update endpoint rejects this field.\n" }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "acknowledgeOverlap": { "type": "boolean" } }, "required": [ "name", "cidr", "datacenterId" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "example": "8.8.8.8" } } } }, "delete_an_empty_vpc": { "name": "delete_an_empty_vpc", "description": "Delete an empty VPC", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" } }, "required": [ "id" ] } }, "get_a_vpc_with_its_child_counts_and_delete_verdict": { "name": "get_a_vpc_with_its_child_counts_and_delete_verdict", "description": "Get a VPC with its child counts and delete verdict", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" } }, "required": [ "id" ] } }, "rename_a_vpc_edit_its_description_or_move_it_between_resource_groups": { "name": "rename_a_vpc_edit_its_description_or_move_it_between_resource_groups", "description": "Rename a VPC, edit its description, or move it between resource groups", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 64, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "resourceGroupId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "list_a_vpc_s_security_groups": { "name": "list_a_vpc_s_security_groups", "description": "List a VPC's security groups", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_security_group_in_a_vpc_async": { "name": "create_a_security_group_in_a_vpc_async", "description": "Create a security group in a VPC (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "description": { "type": "string", "maxLength": 500 }, "rules": { "maxItems": 100, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Accepted and IGNORED. Rule identity is content, not id, so a rule read back from the API round-trips through this body unchanged; an id here selects nothing and updates nothing. Sending it is optional.\n" }, "direction": { "type": "string", "enum": [ "ingress", "egress" ] }, "protocol": { "type": "string", "enum": [ "tcp", "udp", "icmp", "all" ] }, "portRangeMin": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 65535 }, { "type": "null" } ] }, "portRangeMax": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 65535 }, { "type": "null" } ] }, "remoteCidr": { "type": "string", "example": "203.0.113.0/24" }, "description": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] } }, "required": [ "direction", "protocol", "remoteCidr" ], "additionalProperties": {} } } } }, "delete_a_security_group_async": { "name": "delete_a_security_group_async", "description": "Delete a security group (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "nsgId" ] } }, "get_a_security_group_with_its_rules": { "name": "get_a_security_group_with_its_rules", "description": "Get a security group with its rules", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "nsgId" ] } }, "rename_a_security_group_sync_names_are_labels": { "name": "rename_a_security_group_sync_names_are_labels", "description": "Rename a security group (sync — names are labels)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "additionalProperties": {} } }, "required": [ "id", "nsgId", "body" ] } }, "replace_the_security_group_s_rule_set_async": { "name": "replace_the_security_group_s_rule_set_async", "description": "Replace the security group's rule set (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "rules": { "maxItems": 100, "type": "array", "items": { "$ref": "#/definitions/__schema0" } } }, "required": [ "rules" ], "additionalProperties": {} } }, "required": [ "id", "nsgId", "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Accepted and IGNORED, which is what lets a rule set read from the API be sent straight back here: the diff this PUT stages is by rule CONTENT, so an id names no row and changes nothing. Sending it is optional.\n" }, "direction": { "type": "string", "enum": [ "ingress", "egress" ] }, "protocol": { "type": "string", "enum": [ "tcp", "udp", "icmp", "all" ] }, "portRangeMin": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 65535 }, { "type": "null" } ] }, "portRangeMax": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 65535 }, { "type": "null" } ] }, "remoteCidr": { "type": "string", "example": "0.0.0.0/0" }, "description": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] } }, "required": [ "direction", "protocol", "remoteCidr" ], "additionalProperties": {} } } } }, "list_a_vpc_s_elastic_public_ips": { "name": "list_a_vpc_s_elastic_public_ips", "description": "List a VPC's elastic public IPs", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "type": "string", "example": "ipAddress:asc", "description": "field:direction over ipAddress, state or createdAt" }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "state": { "type": "string", "enum": [ "acquiring", "ready", "failed", "removing" ] }, "held": { "type": "boolean", "description": "True selects addresses bound to no machine" } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } }, "acquire_an_elastic_public_ip_in_a_vpc_async": { "name": "acquire_an_elastic_public_ip_in_a_vpc_async", "description": "Acquire an elastic public IP in a VPC (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "body": { "type": "object", "properties": {}, "additionalProperties": false, "description": "No properties. Sent empty, or omitted entirely; any key is rejected 422.\n" } }, "required": [ "id" ] } }, "release_a_public_ip_back_to_the_provider_async": { "name": "release_a_public_ip_back_to_the_provider_async", "description": "Release a public IP back to the provider (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "ipId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "ipId" ] } }, "attach_a_held_public_ip_to_a_vpc_network_interface_async": { "name": "attach_a_held_public_ip_to_a_vpc_network_interface_async", "description": "Attach a held public IP to a VPC network interface (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "ipId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "nicId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The VPC network interface the address binds to" } }, "required": [ "nicId" ], "additionalProperties": {} } }, "required": [ "id", "ipId", "body" ] } }, "detach_a_public_ip_keeping_it_as_a_vpc_holding_async": { "name": "detach_a_public_ip_keeping_it_as_a_vpc_holding_async", "description": "Detach a public IP, keeping it as a VPC holding (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "ipId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "ipId" ] } }, "list_a_vpc_s_subnets": { "name": "list_a_vpc_s_subnets", "description": "List a VPC's subnets", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "state": { "type": "string", "enum": [ "creating", "ready", "failed", "removing" ], "description": "Restrict the list to one lifecycle state. `ready` is the only state a NIC can attach to.\n" } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "create_a_subnet_async_the_row_is_returned_at_once_its_provider_objects_follow": { "name": "create_a_subnet_async_the_row_is_returned_at_once_its_provider_objects_follow", "description": "Create a subnet (async — the row is returned at once, its provider objects follow)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "description": { "type": "string", "maxLength": 500 }, "cidr": { "type": "string", "example": "10.50.1.0/24" }, "prefix": { "type": "integer", "minimum": 22, "maximum": 28 }, "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "name" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "delete_a_subnet_async": { "name": "delete_a_subnet_async", "description": "Delete a subnet (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "subnetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id", "subnetId" ] } }, "rename_or_re_describe_a_subnet_synchronous": { "name": "rename_or_re_describe_a_subnet_synchronous", "description": "Rename or re-describe a subnet (synchronous)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "subnetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 63, "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9 .-]*[a-zA-Z0-9])?$" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "additionalProperties": {} } }, "required": [ "id", "subnetId", "body" ] } }, "list_the_interfaces_attached_to_a_subnet": { "name": "list_the_interfaces_attached_to_a_subnet", "description": "List the interfaces attached to a subnet", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "subnetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "sort": { "default": "createdAt:desc", "description": "Sortable fields: virtualMachineName, networkInterface, createdAt.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] } }, "required": [ "id", "subnetId" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "move_a_subnet_onto_a_different_security_group_async": { "name": "move_a_subnet_onto_a_different_security_group_async", "description": "Move a subnet onto a different security group (async)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource ID (UUID)" }, "subnetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "nsgId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "nsgId" ], "additionalProperties": {} } }, "required": [ "id", "subnetId", "body" ] } }, "list_all_available_roles": { "name": "list_all_available_roles", "description": "List all available roles", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Target tenant ID (defaults to your tenant). Requires hierarchy access for cross-tenant queries." }, "assignable": { "default": false, "description": "If true, returns only roles this user can assign (respects role hierarchy).\nUsers can only assign roles at or below their privilege level.\n", "allOf": [ { "$ref": "#/definitions/__schema0" } ] } }, "definitions": { "__schema0": { "type": "boolean" } } } }, "create_a_custom_role": { "name": "create_a_custom_role", "description": "Create a custom role", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "name": { "type": "string", "example": "custom-viewer" }, "displayName": { "type": "string", "example": "Custom Viewer" }, "description": { "type": "string", "example": "Read-only access to VMs and networks" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Target tenant ID (defaults to your tenant). Requires hierarchy access for cross-tenant creation." }, "permissions": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "List of permissions to assign to this role" } }, "required": [ "name", "displayName" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "resource": { "type": "string", "example": "vm" }, "action": { "type": "string", "example": "read" } }, "required": [ "resource", "action" ], "additionalProperties": {} } } } }, "delete_a_custom_role": { "name": "delete_a_custom_role", "description": "Delete a custom role", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Role ID (UUID)" } }, "required": [ "id" ] } }, "get_a_role_by_id": { "name": "get_a_role_by_id", "description": "Get a role by ID", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Role ID (UUID)" } }, "required": [ "id" ] } }, "update_a_custom_role": { "name": "update_a_custom_role", "description": "Update a custom role", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Role ID (UUID)" }, "body": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Updated Custom Viewer" }, "description": { "anyOf": [ { "type": "string", "description": "Updated description (pass null to clear)" }, { "type": "null" } ], "example": "Updated description for this role" }, "permissions": { "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "Updated list of permissions (replaces existing)" } }, "additionalProperties": {} } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "object", "properties": { "resource": { "type": "string", "example": "vm" }, "action": { "type": "string", "example": "read" } }, "required": [ "resource", "action" ], "additionalProperties": {} } } } }, "list_the_calling_entity_s_sso_providers": { "name": "list_the_calling_entity_s_sso_providers", "description": "List the calling entity's SSO providers", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } } } }, "register_a_new_oidc_provider": { "name": "register_a_new_oidc_provider", "description": "Register a new OIDC provider", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "protocol": { "$ref": "#/definitions/__schema0" }, "providerId": { "$ref": "#/definitions/__schema1" }, "issuer": { "$ref": "#/definitions/__schema2" }, "domain": { "$ref": "#/definitions/__schema3" }, "label": { "$ref": "#/definitions/__schema4" }, "disableImplicitSignUp": { "$ref": "#/definitions/__schema5" }, "clientId": { "$ref": "#/definitions/__schema6" }, "clientSecret": { "$ref": "#/definitions/__schema7" }, "authorizationEndpoint": { "$ref": "#/definitions/__schema8" }, "tokenEndpoint": { "$ref": "#/definitions/__schema9" }, "jwksEndpoint": { "$ref": "#/definitions/__schema10" }, "discoveryEndpoint": { "$ref": "#/definitions/__schema11" }, "scopes": { "$ref": "#/definitions/__schema12" }, "idpMetadataXml": { "$ref": "#/definitions/__schema13" }, "entryPoint": { "$ref": "#/definitions/__schema14" }, "cert": { "$ref": "#/definitions/__schema15" }, "mapping": { "$ref": "#/definitions/__schema16" }, "identifierFormat": { "$ref": "#/definitions/__schema22" } }, "required": [ "providerId", "issuer", "domain" ], "additionalProperties": false, "description": "Register an SSO provider. `protocol` selects the field set: OIDC requires clientId + clientSecret; SAML requires either idpMetadataXml or the entryPoint + cert pair. Fields for the other protocol are rejected." } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "enum": [ "oidc", "saml" ] }, "__schema1": { "type": "string", "description": "Unique, URL-safe identifier for this provider" }, "__schema2": { "type": "string", "format": "uri", "description": "OIDC issuer URL, or the IdP entityID for SAML" }, "__schema3": { "type": "string" }, "__schema4": { "type": "string" }, "__schema5": { "type": "boolean" }, "__schema6": { "type": "string", "description": "OIDC only — required for an OIDC provider" }, "__schema7": { "type": "string", "description": "OIDC only — required for an OIDC provider" }, "__schema8": { "type": "string", "format": "uri" }, "__schema9": { "type": "string", "format": "uri" }, "__schema10": { "type": "string", "format": "uri" }, "__schema11": { "type": "string", "format": "uri" }, "__schema12": { "type": "array", "items": { "type": "string" } }, "__schema13": { "type": "string", "description": "SAML only — full IdP federation metadata XML (mutually sufficient with entryPoint + cert)" }, "__schema14": { "type": "string", "format": "uri", "description": "SAML only — IdP SSO entry point; requires cert" }, "__schema15": { "type": "string", "description": "SAML only — IdP signing certificate (PEM or bare base64); requires entryPoint" }, "__schema16": { "type": "object", "properties": { "id": { "$ref": "#/definitions/__schema17" }, "email": { "$ref": "#/definitions/__schema18" }, "name": { "$ref": "#/definitions/__schema19" }, "image": { "$ref": "#/definitions/__schema20" }, "extraFields": { "$ref": "#/definitions/__schema21" } }, "additionalProperties": false, "description": "SAML assertion-attribute mapping (SAML only). All keys optional; unset keys use the plugin defaults." }, "__schema17": { "type": "string" }, "__schema18": { "type": "string" }, "__schema19": { "type": "string" }, "__schema20": { "type": "string" }, "__schema21": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "__schema22": { "type": "string", "description": "SAML only — NameID format the SP requests" } } } }, "soft_delete_an_sso_provider": { "name": "soft_delete_an_sso_provider", "description": "Soft-delete an SSO provider", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "get_one_sso_provider_entity_isolated": { "name": "get_one_sso_provider_entity_isolated", "description": "Get one SSO provider (entity-isolated)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "update_an_sso_provider_s_config": { "name": "update_an_sso_provider_s_config", "description": "Update an SSO provider's config", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "body": { "type": "object", "properties": { "protocol": { "$ref": "#/definitions/__schema0" }, "issuer": { "$ref": "#/definitions/__schema1" }, "domain": { "$ref": "#/definitions/__schema2" }, "label": { "$ref": "#/definitions/__schema3" }, "enabled": { "$ref": "#/definitions/__schema4" }, "disableImplicitSignUp": { "$ref": "#/definitions/__schema5" }, "clientId": { "$ref": "#/definitions/__schema6" }, "clientSecret": { "$ref": "#/definitions/__schema7" }, "authorizationEndpoint": { "$ref": "#/definitions/__schema8" }, "tokenEndpoint": { "$ref": "#/definitions/__schema9" }, "jwksEndpoint": { "$ref": "#/definitions/__schema10" }, "discoveryEndpoint": { "$ref": "#/definitions/__schema11" }, "scopes": { "$ref": "#/definitions/__schema12" }, "idpMetadataXml": { "$ref": "#/definitions/__schema13" }, "entryPoint": { "$ref": "#/definitions/__schema14" }, "cert": { "$ref": "#/definitions/__schema15" }, "mapping": { "$ref": "#/definitions/__schema16" }, "identifierFormat": { "$ref": "#/definitions/__schema22" } }, "additionalProperties": false, "description": "All fields optional; at least one must be supplied. `protocol` must match the provider's stored protocol (defaults to oidc when omitted) and selects which field set is valid; fields for the other protocol are rejected. clientSecret is write-only and only sent when rotating it." } }, "required": [ "id", "body" ], "definitions": { "__schema0": { "type": "string", "enum": [ "oidc", "saml" ] }, "__schema1": { "type": "string", "format": "uri" }, "__schema2": { "type": "string" }, "__schema3": { "type": "string" }, "__schema4": { "type": "boolean" }, "__schema5": { "type": "boolean", "description": "Write-only — not echoed in read responses." }, "__schema6": { "type": "string", "description": "OIDC only" }, "__schema7": { "type": "string", "description": "OIDC only" }, "__schema8": { "type": "string", "format": "uri" }, "__schema9": { "type": "string", "format": "uri" }, "__schema10": { "type": "string", "format": "uri" }, "__schema11": { "type": "string", "format": "uri" }, "__schema12": { "type": "array", "items": { "type": "string" } }, "__schema13": { "type": "string", "description": "SAML only — replacement IdP federation metadata XML" }, "__schema14": { "type": "string", "format": "uri", "description": "SAML only — requires cert" }, "__schema15": { "type": "string", "description": "SAML only — requires entryPoint" }, "__schema16": { "type": "object", "properties": { "id": { "$ref": "#/definitions/__schema17" }, "email": { "$ref": "#/definitions/__schema18" }, "name": { "$ref": "#/definitions/__schema19" }, "image": { "$ref": "#/definitions/__schema20" }, "extraFields": { "$ref": "#/definitions/__schema21" } }, "additionalProperties": false, "description": "SAML assertion-attribute mapping (SAML only). All keys optional; unset keys use the plugin defaults." }, "__schema17": { "type": "string" }, "__schema18": { "type": "string" }, "__schema19": { "type": "string" }, "__schema20": { "type": "string" }, "__schema21": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" } }, "__schema22": { "type": "string", "description": "SAML only" } } } }, "initialize_domain_verification_generate_or_rotate_token": { "name": "initialize_domain_verification_generate_or_rotate_token", "description": "Initialize domain verification (generate or rotate token)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "get_current_domain_verification_state_no_dns_check": { "name": "get_current_domain_verification_state_no_dns_check", "description": "Get current domain verification state (no DNS check)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "verify_domain_ownership_via_dns_txt_lookup": { "name": "verify_domain_ownership_via_dns_txt_lookup", "description": "Verify domain ownership via DNS TXT lookup", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "id" ] } }, "dry_run_extract_of_pasted_saml_id_p_metadata_no_persistence": { "name": "dry_run_extract_of_pasted_saml_id_p_metadata_no_persistence", "description": "Dry-run extract of pasted SAML IdP metadata (no persistence)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "idpMetadataXml": { "$ref": "#/definitions/__schema0" } }, "required": [ "idpMetadataXml" ], "additionalProperties": false, "description": "Body for the stateless SAML metadata dry-run — the raw IdP federation XML to extract from." } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "description": "Full IdP federation metadata XML to extract from" } } } }, "list_all_users": { "name": "list_all_users", "description": "List all users", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter users by tenant ID" }, "excludeResourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Exclude users from specified resource group (filter for \"add to group\" dialogs)" }, "inviteStatus": { "type": "array", "items": { "$ref": "#/definitions/__schema2" }, "description": "Filter by invite/activation status. Supports multiple values (repeated params).\nExample: ?inviteStatus=pending&inviteStatus=expired\n" }, "deletedFilter": { "type": "string", "enum": [ "exclude", "include", "only" ], "description": "Filter for deleted users visibility:\n- exclude (default): Only show active users\n- include: Show both active and deleted users\n- only: Show only deleted users\n" }, "resourceGroupId": { "type": "array", "items": { "$ref": "#/definitions/__schema3" }, "description": "Filter by resource group IDs. Supports multiple values (repeated params).\nUse '0' to include users with no resource groups assigned.\nExample: ?resourceGroupId=abc-123&resourceGroupId=0 (users in group abc-123 OR users with no groups)\n" }, "roleId": { "type": "array", "items": { "$ref": "#/definitions/__schema4" }, "description": "Filter by role IDs. Supports multiple values (repeated params).\nUse '0' to include users with no roles assigned.\nExample: ?roleId=abc-123&roleId=0 (users with role abc-123 OR users with no roles)\n" }, "noResourceGroup": { "type": "boolean", "description": "Filter for users with no resource groups assigned. Shorthand for resourceGroupId=0." }, "noRole": { "type": "boolean", "description": "Filter for users with no roles assigned. Shorthand for roleId=0." } }, "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" }, "__schema2": { "type": "string", "enum": [ "activated", "pending", "expired" ] }, "__schema3": { "type": "string" }, "__schema4": { "type": "string" } } } }, "create_a_new_user_register_or_invite": { "name": "create_a_new_user_register_or_invite", "description": "Create a new user (register or invite)", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "oneOf": [ { "type": "object", "properties": { "email": { "$ref": "#/definitions/__schema0" }, "password": { "$ref": "#/definitions/__schema1" }, "firstName": { "$ref": "#/definitions/__schema2" }, "lastName": { "$ref": "#/definitions/__schema3" }, "roleNames": { "$ref": "#/definitions/__schema4" }, "resourceGroupIds": { "$ref": "#/definitions/__schema6" }, "entityId": { "$ref": "#/definitions/__schema8" }, "action": { "$ref": "#/definitions/__schema9" } }, "required": [ "email", "password", "firstName", "lastName", "action" ], "additionalProperties": { "$ref": "#/definitions/__schema10" }, "title": "Register User Request" }, { "type": "object", "properties": { "email": { "$ref": "#/definitions/__schema11" }, "firstName": { "$ref": "#/definitions/__schema12" }, "lastName": { "$ref": "#/definitions/__schema13" }, "roleNames": { "$ref": "#/definitions/__schema14" }, "resourceGroupIds": { "$ref": "#/definitions/__schema16" }, "entityId": { "$ref": "#/definitions/__schema18" }, "action": { "$ref": "#/definitions/__schema19" } }, "required": [ "email", "firstName", "lastName" ], "additionalProperties": { "$ref": "#/definitions/__schema20" }, "title": "Invite User Request" } ], "discriminator": { "propertyName": "action" } } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "__schema1": { "type": "string", "minLength": 12, "maxLength": 50, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[`!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>/?~])(?!.*\\s).{12,50}$", "description": "Password must meet complexity requirements:\n- Between 12 and 50 characters\n- No spaces allowed\n- At least one uppercase letter (A-Z)\n- At least one lowercase letter (a-z)\n- At least one number (0-9)\n- At least one special character\n" }, "__schema2": { "type": "string" }, "__schema3": { "type": "string" }, "__schema4": { "type": "array", "items": { "$ref": "#/definitions/__schema5" }, "description": "Role names to assign (e.g., ['tenant-user', 'vm-operator']). Defaults to ['tenant-user']." }, "__schema5": { "type": "string" }, "__schema6": { "type": "array", "items": { "$ref": "#/definitions/__schema7" }, "description": "Resource group IDs to assign user to" }, "__schema7": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema8": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema9": { "type": "string", "const": "register" }, "__schema10": {}, "__schema11": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "__schema12": { "type": "string", "minLength": 1, "description": "Required. User's first name; pre-populates the account-activation form." }, "__schema13": { "type": "string", "minLength": 1, "description": "Required. User's last name; pre-populates the account-activation form." }, "__schema14": { "type": "array", "items": { "$ref": "#/definitions/__schema15" }, "description": "Role names to assign (e.g., ['tenant-user', 'vm-operator']). Defaults to ['tenant-user']." }, "__schema15": { "type": "string" }, "__schema16": { "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema17" }, "description": "Resource group IDs to assign user to. Each must belong to the entity the user is created in; a group from any other entity is refused with 403.\n" }, "__schema17": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema18": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema19": { "type": "string", "const": "invite" }, "__schema20": {} } } }, "bulk_assign_resource_groups_to_users": { "name": "bulk_assign_resource_groups_to_users", "description": "Bulk assign resource groups to users", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "userIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "User IDs to assign resource groups to" }, "resourceGroupIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema1" }, "description": "Resource group IDs to assign to users" } }, "required": [ "userIds", "resourceGroupIds" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "__schema1": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "bulk_assign_role_to_users": { "name": "bulk_assign_role_to_users", "description": "Bulk assign role to users", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "userIds": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "User IDs to assign the role to" }, "roleName": { "type": "string", "description": "The name of the role to assign" } }, "required": [ "userIds", "roleName" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "bulk_delete_users": { "name": "bulk_delete_users", "description": "Bulk delete users", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "User IDs to delete" } }, "required": [ "ids" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "bulk_resend_user_invitations": { "name": "bulk_resend_user_invitations", "description": "Bulk resend user invitations", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "$ref": "#/definitions/__schema0" }, "description": "User IDs to resend invitations to" } }, "required": [ "ids" ], "additionalProperties": {} } }, "required": [ "body" ], "definitions": { "__schema0": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } } }, "delete_a_user": { "name": "delete_a_user", "description": "Delete a user", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" } }, "required": [ "id" ] } }, "get_user_details_by_id": { "name": "get_user_details_by_id", "description": "Get user details by ID", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" } }, "required": [ "id" ] } }, "update_user_details": { "name": "update_user_details", "description": "Update user details", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" }, "body": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Optional. Tenant ID to move the user to. Must be within accessible hierarchy." } }, "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "confirm_user_email": { "name": "confirm_user_email", "description": "Confirm user email", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" }, "body": { "type": "object", "properties": { "token": { "type": "string", "description": "Password reset token from email" }, "password": { "type": "string", "minLength": 12, "maxLength": 50, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[`!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>/?~])(?!.*\\s).{12,50}$", "description": "Password must meet complexity requirements:\n- Between 12 and 50 characters\n- No spaces allowed\n- At least one uppercase letter (A-Z)\n- At least one lowercase letter (a-z)\n- At least one number (0-9)\n- At least one special character (no space)\n" }, "firstName": { "type": "string", "description": "Optional if pre-populated at invite time. Required otherwise." }, "lastName": { "type": "string", "description": "Optional if pre-populated at invite time. Required otherwise." }, "tosAccepted": { "type": "boolean", "const": true }, "aupAccepted": { "type": "boolean", "const": true }, "dpaAccepted": { "type": "boolean", "const": true }, "productUpdatesOptIn": { "type": "boolean", "description": "Optional opt-in to receive product-update communications" } }, "required": [ "token", "password", "aupAccepted" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "update_user_password": { "name": "update_user_password", "description": "Update user password", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID (must match authenticated user)" }, "body": { "type": "object", "properties": { "oldPassword": { "type": "string" }, "password": { "type": "string", "minLength": 12, "maxLength": 50, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[`!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>/?~])(?!.*\\s).{12,50}$", "description": "Password must meet complexity requirements:\n- Between 12 and 50 characters\n- No spaces allowed\n- At least one uppercase letter (A-Z)\n- At least one lowercase letter (a-z)\n- At least one number (0-9)\n- At least one special character (no space)\n" } }, "required": [ "oldPassword", "password" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "complete_password_reset": { "name": "complete_password_reset", "description": "Complete password reset", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" }, "body": { "type": "object", "properties": { "token": { "type": "string", "description": "Password reset token from email" }, "password": { "type": "string", "minLength": 12, "maxLength": 50, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[`!@#$%^&*()_+\\-=\\[\\]{};':\"\\\\|,.<>/?~])(?!.*\\s).{12,50}$", "description": "Password must meet complexity requirements:\n- Between 12 and 50 characters\n- No spaces allowed\n- At least one uppercase letter (A-Z)\n- At least one lowercase letter (a-z)\n- At least one number (0-9)\n- At least one special character (no space)\n" } }, "required": [ "token", "password" ], "additionalProperties": {} } }, "required": [ "id", "body" ] } }, "get_pending_activation_info": { "name": "get_pending_activation_info", "description": "Get pending activation info", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID from activation email link" }, "token": { "type": "string", "description": "Activation token from email link" } }, "required": [ "id", "token" ] } }, "resend_user_invitation_email": { "name": "resend_user_invitation_email", "description": "Resend user invitation email", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID of the pending user" } }, "required": [ "id" ] } }, "get_resource_groups_for_a_user": { "name": "get_resource_groups_for_a_user", "description": "Get resource groups for a user", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID" }, "page": { "default": 1, "description": "Page number (1-indexed, default: 1)", "allOf": [ { "$ref": "#/definitions/__schema0" } ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100, "description": "Items per page (max varies by endpoint; default max 100)" }, "search": { "type": "string", "description": "Search term to filter results across relevant text fields" }, "sort": { "default": "createdAt:desc", "description": "Sort field and direction (e.g., \"createdAt:desc\", \"name:asc\"). Supports comma-separated values for multi-column sorting.", "allOf": [ { "$ref": "#/definitions/__schema1" } ] } }, "required": [ "id" ], "definitions": { "__schema0": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "__schema1": { "type": "string" } } } }, "get_currently_authenticated_user": { "name": "get_currently_authenticated_user", "description": "Get currently authenticated user", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {} } }, "request_password_reset": { "name": "request_password_reset", "description": "Request password reset", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "body": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "email" ], "additionalProperties": {} } }, "required": [ "body" ] } }, "get_user_role_assignments": { "name": "get_user_role_assignments", "description": "Get user role assignments", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID (UUID)" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Filter roles by tenant (defaults to your tenant). Requires hierarchy access for cross-tenant queries." } }, "required": [ "userId" ] } }, "assign_a_role_to_a_user": { "name": "assign_a_role_to_a_user", "description": "Assign a role to a user", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID (UUID)" }, "body": { "type": "object", "properties": { "roleName": { "type": "string", "description": "Role name to assign (e.g., tenant-admin, team-admin)" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Tenant scope (defaults to your tenant). Requires hierarchy access for cross-tenant assignments." }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group scope (optional, for group-scoped roles)" } }, "required": [ "roleName" ], "additionalProperties": {} } }, "required": [ "userId", "body" ] } }, "revoke_a_role_from_a_user": { "name": "revoke_a_role_from_a_user", "description": "Revoke a role from a user", "inputSchema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "User ID (UUID)" }, "roleName": { "type": "string", "description": "Role name to revoke" }, "entityId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Tenant scope filter (defaults to your tenant). Requires hierarchy access for cross-tenant revocations." }, "resourceGroupId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Resource group scope filter" } }, "required": [ "userId", "roleName" ] } } }, "resources": [], "prompts": [] } }