{ "openapi": "3.1.0", "info": { "title": "IntentCenter API", "description": "IntentCenter \u2014 DCIM, IPAM, circuits, automation, and closed-loop inventory (clean-room derived). Read-only GraphQL at /graphql.", "version": "0.1.0" }, "paths": { "/health": { "get": { "tags": [ "health" ], "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Health Health Get" } } } } } } }, "/v1/auth/providers": { "get": { "tags": [ "auth" ], "summary": "Get Providers", "operationId": "get_providers_v1_auth_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response Get Providers V1 Auth Providers Get" } } } } } } }, "/v1/auth/login": { "post": { "tags": [ "auth" ], "summary": "Post Login", "operationId": "post_login_v1_auth_login_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Login V1 Auth Login Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Post Logout", "operationId": "post_logout_v1_auth_logout_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "boolean" }, "type": "object", "title": "Response Post Logout V1 Auth Logout Post" } } } } } } }, "/v1/auth/sso/{provider}/start": { "get": { "tags": [ "auth" ], "summary": "Sso Start", "operationId": "sso_start_v1_auth_sso__provider__start_get", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me": { "get": { "tags": [ "core" ], "summary": "Get Me", "operationId": "get_me_v1_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Me V1 Me Get" } } } } } }, "patch": { "tags": [ "core" ], "summary": "Patch Me", "operationId": "patch_me_v1_me_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MePatchBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Patch Me V1 Me Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/me/password": { "post": { "tags": [ "core" ], "summary": "Post Me Password", "operationId": "post_me_password_v1_me_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MePasswordBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Me Password V1 Me Password Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tokens": { "get": { "tags": [ "core" ], "summary": "Get Tokens", "description": "List API tokens for this organization (metadata only; never the secret).", "operationId": "get_tokens_v1_tokens_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response Get Tokens V1 Tokens Get" } } } } } }, "post": { "tags": [ "core" ], "summary": "Post Tokens", "operationId": "post_tokens_v1_tokens_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenCreateBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Tokens V1 Tokens Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/webhooks": { "post": { "tags": [ "core" ], "summary": "Post Webhooks", "operationId": "post_webhooks_v1_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Webhooks V1 Webhooks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/audit-events": { "get": { "tags": [ "core" ], "summary": "Get Audit Events", "operationId": "get_audit_events_v1_audit_events_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response Get Audit Events V1 Audit Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/plugins": { "get": { "tags": [ "core" ], "summary": "Get Plugins", "operationId": "get_plugins_v1_plugins_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response Get Plugins V1 Plugins Get" } } } } } } }, "/v1/plugins/install": { "post": { "tags": [ "core" ], "summary": "Post Plugin Install", "description": "Reserved for a signed install pipeline, artifact store, and verification; not available yet.", "operationId": "post_plugin_install_v1_plugins_install_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/resource-extensions/batch": { "get": { "tags": [ "core" ], "summary": "Get Resource Extensions Batch", "description": "Return extension rows for many resources in one round-trip (template + custom JSON).", "operationId": "get_resource_extensions_batch_v1_resource_extensions_batch_get", "parameters": [ { "name": "resourceType", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Resourcetype" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "string", "description": "Comma-separated resource UUIDs", "title": "Ids" }, "description": "Comma-separated resource UUIDs" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true } }, "title": "Response Get Resource Extensions Batch V1 Resource Extensions Batch Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/resource-extensions/{resource_type}/{resource_id}": { "put": { "tags": [ "core" ], "summary": "Put Resource Extension", "operationId": "put_resource_extension_v1_resource_extensions__resource_type___resource_id__put", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceExtensionPut" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Put Resource Extension V1 Resource Extensions Resource Type Resource Id Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/ui/page-registry": { "get": { "tags": [ "ui" ], "summary": "Get Page Registry", "description": "Returns stable pageIds and route metadata for the web shell. Authenticated (session or API token).", "operationId": "get_page_registry_v1_ui_page_registry_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Page Registry V1 Ui Page Registry Get" } } } } } } }, "/v1/ui/placements": { "get": { "tags": [ "ui" ], "summary": "List Placements", "description": "List enabled widget placements for the current organization and page.", "operationId": "list_placements_v1_ui_placements_get", "parameters": [ { "name": "pageId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Pageid" } }, { "name": "resourceType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resourcetype" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response List Placements V1 Ui Placements Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/ui/navigation": { "get": { "tags": [ "ui" ], "summary": "Get Merged Navigation", "description": "Merges core admin links with per-org `PluginRegistration.manifest.navigation` (same-origin only).", "operationId": "get_merged_navigation_v1_ui_navigation_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Merged Navigation V1 Ui Navigation Get" } } } } } } }, "/v1/ui/federation": { "get": { "tags": [ "ui" ], "summary": "Get Federation Manifest", "description": "No remote module federation in this build; shell loads only bundled widget keys. Reserved for a future shape.", "operationId": "get_federation_manifest_v1_ui_federation_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Federation Manifest V1 Ui Federation Get" } } } } } } }, "/v1/users": { "get": { "tags": [ "users" ], "summary": "List Users", "operationId": "list_users_v1_users_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by email (contains, case-insensitive)", "title": "Q" }, "description": "Filter by email (contains, case-insensitive)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response List Users V1 Users Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "users" ], "summary": "Create User", "operationId": "create_user_v1_users_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create User V1 Users Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get User", "operationId": "get_user_v1_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get User V1 Users User Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Patch User", "operationId": "patch_user_v1_users__user_id__patch", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPatchBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch User V1 Users User Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/identity": { "get": { "tags": [ "admin", "identity" ], "summary": "Get Admin Identity", "description": "Effective identity for the signed-in org (env overrides; secrets never in plaintext in JSON for sensitive fields).", "operationId": "get_admin_identity_v1_admin_identity_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Admin Identity V1 Admin Identity Get" } } } } } }, "patch": { "tags": [ "admin", "identity" ], "summary": "Patch Admin Identity", "operationId": "patch_admin_identity_v1_admin_identity_patch", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Patch Admin Identity V1 Admin Identity Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/identity/test": { "post": { "tags": [ "admin", "identity" ], "summary": "Post Admin Identity Test", "description": "Test LDAP bind or fetch OpenID metadata for the selected directory (admin only; does not persist).", "operationId": "post_admin_identity_test_v1_admin_identity_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityTestRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "type": "object", "title": "Response Post Admin Identity Test V1 Admin Identity Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/location-types": { "get": { "tags": [ "dcim" ], "summary": "List Location Types", "operationId": "list_location_types_v1_location_types_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Location Types V1 Location Types Get" } } } } } } }, "/v1/device-roles": { "get": { "tags": [ "dcim" ], "summary": "List Device Roles", "operationId": "list_device_roles_v1_device_roles_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Device Roles V1 Device Roles Get" } } } } } } }, "/v1/device-types": { "get": { "tags": [ "dcim" ], "summary": "List Device Types", "operationId": "list_device_types_v1_device_types_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Device Types V1 Device Types Get" } } } } } } }, "/v1/locations": { "get": { "tags": [ "dcim" ], "summary": "List Locations", "operationId": "list_locations_v1_locations_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Locations V1 Locations Get" } } } } } }, "post": { "tags": [ "dcim" ], "summary": "Create Location", "operationId": "create_location_v1_locations_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Location V1 Locations Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/locations/{location_id}": { "get": { "tags": [ "dcim" ], "summary": "Get Location", "operationId": "get_location_v1_locations__location_id__get", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "title": "Response Get Location V1 Locations Location Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "dcim" ], "summary": "Update Location", "operationId": "update_location_v1_locations__location_id__patch", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Location V1 Locations Location Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "dcim" ], "summary": "Delete Location", "operationId": "delete_location_v1_locations__location_id__delete", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Location Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Delete Location V1 Locations Location Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/racks": { "get": { "tags": [ "dcim" ], "summary": "List Racks", "operationId": "list_racks_v1_racks_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Racks V1 Racks Get" } } } } } }, "post": { "tags": [ "dcim" ], "summary": "Create Rack", "operationId": "create_rack_v1_racks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Rack V1 Racks Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/racks/{rack_id}": { "get": { "tags": [ "dcim" ], "summary": "Get Rack", "operationId": "get_rack_v1_racks__rack_id__get", "parameters": [ { "name": "rack_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Rack Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "title": "Response Get Rack V1 Racks Rack Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "dcim" ], "summary": "Update Rack", "operationId": "update_rack_v1_racks__rack_id__patch", "parameters": [ { "name": "rack_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Rack Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RackUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Rack V1 Racks Rack Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "dcim" ], "summary": "Delete Rack", "operationId": "delete_rack_v1_racks__rack_id__delete", "parameters": [ { "name": "rack_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Rack Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Delete Rack V1 Racks Rack Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/devices": { "get": { "tags": [ "dcim" ], "summary": "List Devices", "operationId": "list_devices_v1_devices_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Devices V1 Devices Get" } } } } } }, "post": { "tags": [ "dcim" ], "summary": "Create Device", "operationId": "create_device_v1_devices_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Device V1 Devices Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/devices/{device_id}": { "get": { "tags": [ "dcim" ], "summary": "Get Device", "operationId": "get_device_v1_devices__device_id__get", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Device Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "title": "Response Get Device V1 Devices Device Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "dcim" ], "summary": "Update Device", "operationId": "update_device_v1_devices__device_id__patch", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Device Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Device V1 Devices Device Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "dcim" ], "summary": "Delete Device", "operationId": "delete_device_v1_devices__device_id__delete", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Device Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Response Delete Device V1 Devices Device Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/devices/{device_id}/interfaces": { "post": { "tags": [ "dcim" ], "summary": "Create Interface", "operationId": "create_interface_v1_devices__device_id__interfaces_post", "parameters": [ { "name": "device_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Device Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterfaceCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Interface V1 Devices Device Id Interfaces Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/cables": { "post": { "tags": [ "dcim" ], "summary": "Create Cable", "operationId": "create_cable_v1_cables_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CableCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Cable V1 Cables Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vrfs": { "get": { "tags": [ "ipam" ], "summary": "List Vrfs", "operationId": "list_vrfs_v1_vrfs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Vrfs V1 Vrfs Get" } } } } } }, "post": { "tags": [ "ipam" ], "summary": "Create Vrf", "operationId": "create_vrf_v1_vrfs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrfCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Vrf V1 Vrfs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vrfs/{vrf_id}": { "get": { "tags": [ "ipam" ], "summary": "Get Vrf", "operationId": "get_vrf_v1_vrfs__vrf_id__get", "parameters": [ { "name": "vrf_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vrf Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Vrf V1 Vrfs Vrf Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ipam" ], "summary": "Update Vrf", "operationId": "update_vrf_v1_vrfs__vrf_id__patch", "parameters": [ { "name": "vrf_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vrf Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrfUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Vrf V1 Vrfs Vrf Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/prefixes": { "get": { "tags": [ "ipam" ], "summary": "List Prefixes", "operationId": "list_prefixes_v1_prefixes_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Prefixes V1 Prefixes Get" } } } } } }, "post": { "tags": [ "ipam" ], "summary": "Create Prefix", "operationId": "create_prefix_v1_prefixes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefixCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Prefix V1 Prefixes Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/prefixes/{prefix_id}": { "get": { "tags": [ "ipam" ], "summary": "Get Prefix", "operationId": "get_prefix_v1_prefixes__prefix_id__get", "parameters": [ { "name": "prefix_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prefix Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Prefix V1 Prefixes Prefix Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ipam" ], "summary": "Update Prefix", "operationId": "update_prefix_v1_prefixes__prefix_id__patch", "parameters": [ { "name": "prefix_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prefix Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrefixUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Prefix V1 Prefixes Prefix Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/ip-addresses": { "get": { "tags": [ "ipam" ], "summary": "List Ip Addresses", "operationId": "list_ip_addresses_v1_ip_addresses_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Ip Addresses V1 Ip Addresses Get" } } } } } }, "post": { "tags": [ "ipam" ], "summary": "Create Ip Address", "operationId": "create_ip_address_v1_ip_addresses_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAddressCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Ip Address V1 Ip Addresses Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/ip-addresses/{ip_address_id}": { "get": { "tags": [ "ipam" ], "summary": "Get Ip Address", "operationId": "get_ip_address_v1_ip_addresses__ip_address_id__get", "parameters": [ { "name": "ip_address_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Ip Address Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Ip Address V1 Ip Addresses Ip Address Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ipam" ], "summary": "Update Ip Address", "operationId": "update_ip_address_v1_ip_addresses__ip_address_id__patch", "parameters": [ { "name": "ip_address_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Ip Address Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAddressUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Ip Address V1 Ip Addresses Ip Address Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vlans": { "get": { "tags": [ "ipam" ], "summary": "List Vlans", "operationId": "list_vlans_v1_vlans_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Vlans V1 Vlans Get" } } } } } }, "post": { "tags": [ "ipam" ], "summary": "Create Vlan", "operationId": "create_vlan_v1_vlans_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Vlan V1 Vlans Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vlans/{vlan_id}": { "get": { "tags": [ "ipam" ], "summary": "Get Vlan", "operationId": "get_vlan_v1_vlans__vlan_id__get", "parameters": [ { "name": "vlan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vlan Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Vlan V1 Vlans Vlan Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "ipam" ], "summary": "Update Vlan", "operationId": "update_vlan_v1_vlans__vlan_id__patch", "parameters": [ { "name": "vlan_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Vlan Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VlanUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Vlan V1 Vlans Vlan Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/providers": { "get": { "tags": [ "circuits" ], "summary": "List Providers", "operationId": "list_providers_v1_providers_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Providers V1 Providers Get" } } } } } }, "post": { "tags": [ "circuits" ], "summary": "Create Provider", "operationId": "create_provider_v1_providers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Provider V1 Providers Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/providers/{provider_id}": { "get": { "tags": [ "circuits" ], "summary": "Get Provider", "operationId": "get_provider_v1_providers__provider_id__get", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Provider V1 Providers Provider Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "circuits" ], "summary": "Update Provider", "operationId": "update_provider_v1_providers__provider_id__patch", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Provider Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Provider V1 Providers Provider Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/circuits": { "get": { "tags": [ "circuits" ], "summary": "List Circuits", "operationId": "list_circuits_v1_circuits_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Circuits V1 Circuits Get" } } } } } }, "post": { "tags": [ "circuits" ], "summary": "Create Circuit", "operationId": "create_circuit_v1_circuits_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CircuitCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Circuit V1 Circuits Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/circuits/{circuit_id}": { "get": { "tags": [ "circuits" ], "summary": "Get Circuit", "operationId": "get_circuit_v1_circuits__circuit_id__get", "parameters": [ { "name": "circuit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Circuit Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Circuit V1 Circuits Circuit Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "circuits" ], "summary": "Update Circuit", "operationId": "update_circuit_v1_circuits__circuit_id__patch", "parameters": [ { "name": "circuit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Circuit Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CircuitUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Circuit V1 Circuits Circuit Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/circuits/{circuit_id}/segments": { "post": { "tags": [ "circuits" ], "summary": "Create Circuit Segment", "operationId": "create_circuit_segment_v1_circuits__circuit_id__segments_post", "parameters": [ { "name": "circuit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Circuit Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CircuitSegmentCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Circuit Segment V1 Circuits Circuit Id Segments Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/circuits/{circuit_id}/segments/{segment_id}": { "delete": { "tags": [ "circuits" ], "summary": "Delete Circuit Segment", "operationId": "delete_circuit_segment_v1_circuits__circuit_id__segments__segment_id__delete", "parameters": [ { "name": "circuit_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Circuit Id" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Segment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Circuit Segment V1 Circuits Circuit Id Segments Segment Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/jobs": { "get": { "tags": [ "automation" ], "summary": "List Jobs", "operationId": "list_jobs_v1_jobs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Jobs V1 Jobs Get" } } } } } }, "post": { "tags": [ "automation" ], "summary": "Create Job", "operationId": "create_job_v1_jobs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Job V1 Jobs Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/jobs/{job_definition_id}": { "get": { "tags": [ "automation" ], "summary": "Get Job Definition", "operationId": "get_job_definition_v1_jobs__job_definition_id__get", "parameters": [ { "name": "job_definition_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Definition Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Job Definition V1 Jobs Job Definition Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "automation" ], "summary": "Update Job Definition", "operationId": "update_job_definition_v1_jobs__job_definition_id__patch", "parameters": [ { "name": "job_definition_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Definition Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDefinitionUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Job Definition V1 Jobs Job Definition Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/jobs/{key}/run": { "post": { "tags": [ "automation" ], "summary": "Run Job", "operationId": "run_job_v1_jobs__key__run_post", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "title": "Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRunBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Run Job V1 Jobs Key Run Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/job-runs": { "get": { "tags": [ "automation" ], "summary": "List Job Runs", "operationId": "list_job_runs_v1_job_runs_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Job Runs V1 Job Runs Get" } } } } } } }, "/v1/change-requests": { "get": { "tags": [ "automation" ], "summary": "List Change Requests", "operationId": "list_change_requests_v1_change_requests_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Change Requests V1 Change Requests Get" } } } } } }, "post": { "tags": [ "automation" ], "summary": "Create Change Request", "operationId": "create_change_request_v1_change_requests_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRequestCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Change Request V1 Change Requests Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/services": { "get": { "tags": [ "automation" ], "summary": "List Services", "operationId": "list_services_v1_services_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Services V1 Services Get" } } } } } }, "post": { "tags": [ "automation" ], "summary": "Create Service", "operationId": "create_service_v1_services_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Service V1 Services Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/services/{service_id}": { "get": { "tags": [ "automation" ], "summary": "Get Service", "operationId": "get_service_v1_services__service_id__get", "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Service Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Service V1 Services Service Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "automation" ], "summary": "Update Service", "operationId": "update_service_v1_services__service_id__patch", "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Service Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Service V1 Services Service Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/observed-state": { "get": { "tags": [ "reconciliation" ], "summary": "List Observed State", "operationId": "list_observed_state_v1_observed_state_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Observed State V1 Observed State Get" } } } } } }, "post": { "tags": [ "reconciliation" ], "summary": "Post Observed State", "operationId": "post_observed_state_v1_observed_state_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObservedStateBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Observed State V1 Observed State Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/templates/resource-types": { "get": { "tags": [ "templates" ], "summary": "List Resource Types", "operationId": "list_resource_types_v1_templates_resource_types_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Response List Resource Types V1 Templates Resource Types Get" } } } } } } }, "/v1/templates": { "get": { "tags": [ "templates" ], "summary": "List Templates", "operationId": "list_templates_v1_templates_get", "parameters": [ { "name": "resourceType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resourcetype" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response List Templates V1 Templates Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "templates" ], "summary": "Create Template", "operationId": "create_template_v1_templates_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Template V1 Templates Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/templates/{template_id}": { "get": { "tags": [ "templates" ], "summary": "Get Template", "operationId": "get_template_v1_templates__template_id__get", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true }, "title": "Response Get Template V1 Templates Template Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "templates" ], "summary": "Update Template", "operationId": "update_template_v1_templates__template_id__patch", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Template V1 Templates Template Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "templates" ], "summary": "Delete Template", "operationId": "delete_template_v1_templates__template_id__delete", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Template V1 Templates Template Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/templates/{template_id}/set-default": { "post": { "tags": [ "templates" ], "summary": "Set Default Template", "operationId": "set_default_template_v1_templates__template_id__set_default_post", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Set Default Template V1 Templates Template Id Set Default Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/search": { "get": { "tags": [ "search" ], "summary": "Global Search", "operationId": "global_search_v1_search_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 200, "default": "", "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50, "minimum": 1, "default": 15, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response Global Search V1 Search Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/resource-graph/{resource_type}/{resource_id}": { "get": { "tags": [ "resource-graph" ], "summary": "Get Resource Graph", "operationId": "get_resource_graph_v1_resource_graph__resource_type___resource_id__get", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Resource Graph V1 Resource Graph Resource Type Resource Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/resource-view/{resource_type}/{resource_id}": { "get": { "tags": [ "resource-view" ], "summary": "Get Resource View", "operationId": "get_resource_view_v1_resource_view__resource_type___resource_id__get", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "resource_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Resource Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Resource View V1 Resource View Resource Type Resource Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/bulk/{resource_type}/export": { "get": { "tags": [ "bulk" ], "summary": "Bulk Export", "operationId": "bulk_export_v1_bulk__resource_type__export_get", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "format", "in": "query", "required": false, "schema": { "enum": [ "csv", "json" ], "type": "string", "default": "csv", "title": "Format" } }, { "name": "template", "in": "query", "required": false, "schema": { "type": "boolean", "description": "If true, return headers / empty template only", "default": false, "title": "Template" }, "description": "If true, return headers / empty template only" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "object", "additionalProperties": { "type": "string" } } ], "title": "Response Bulk Export V1 Bulk Resource Type Export Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/bulk/{resource_type}/import/json": { "post": { "tags": [ "bulk" ], "summary": "Bulk Import Json", "operationId": "bulk_import_json_v1_bulk__resource_type__import_json_post", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJsonImportBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Bulk Import Json V1 Bulk Resource Type Import Json Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/bulk/{resource_type}/import/csv": { "post": { "tags": [ "bulk" ], "summary": "Bulk Import Csv", "operationId": "bulk_import_csv_v1_bulk__resource_type__import_csv_post", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "skipErrors", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Skiperrors" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_bulk_import_csv_v1_bulk__resource_type__import_csv_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Bulk Import Csv V1 Bulk Resource Type Import Csv Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/catalog/{resource_type}/items": { "get": { "tags": [ "catalog" ], "summary": "Catalog Items", "operationId": "catalog_items_v1_catalog__resource_type__items_get", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response Catalog Items V1 Catalog Resource Type Items Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/catalog/{resource_type}/items/{item_id}": { "get": { "tags": [ "catalog" ], "summary": "Get Catalog Item", "operationId": "get_catalog_item_v1_catalog__resource_type__items__item_id__get", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Catalog Item V1 Catalog Resource Type Items Item Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "catalog" ], "summary": "Patch Catalog Item", "operationId": "patch_catalog_item_v1_catalog__resource_type__items__item_id__patch", "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Resource Type" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Item Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Catalog Item V1 Catalog Resource Type Items Item Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connectors": { "get": { "tags": [ "connectors" ], "summary": "List Connectors", "operationId": "list_connectors_v1_connectors_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Response List Connectors V1 Connectors Get" } } } } } }, "post": { "tags": [ "connectors" ], "summary": "Create Connector", "operationId": "create_connector_v1_connectors_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorCreate" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Connector V1 Connectors Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connectors/test": { "post": { "tags": [ "connectors" ], "summary": "Test Connector", "description": "Run the same HTTP probe as connector.sync without writing health columns.\nUse connectorId to test a saved row, or omit it and pass type + settings (and optional credentials) for a draft.", "operationId": "test_connector_v1_connectors_test_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorTestBody" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Test Connector V1 Connectors Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connectors/{connector_id}": { "get": { "tags": [ "connectors" ], "summary": "Get Connector", "operationId": "get_connector_v1_connectors__connector_id__get", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Connector V1 Connectors Connector Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "connectors" ], "summary": "Update Connector", "operationId": "update_connector_v1_connectors__connector_id__patch", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Update Connector V1 Connectors Connector Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "connectors" ], "summary": "Delete Connector", "operationId": "delete_connector_v1_connectors__connector_id__delete", "parameters": [ { "name": "connector_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Connector Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/llm": { "get": { "tags": [ "copilot" ], "summary": "Get Admin Llm", "operationId": "get_admin_llm_v1_admin_llm_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Admin Llm V1 Admin Llm Get" } } } } } }, "patch": { "tags": [ "copilot" ], "summary": "Patch Admin Llm", "operationId": "patch_admin_llm_v1_admin_llm_patch", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Patch Admin Llm V1 Admin Llm Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/llm/test": { "post": { "tags": [ "copilot" ], "summary": "Post Admin Llm Test", "description": "Verify OpenAI-compatible /chat/completions with current or draft values (admin only).", "operationId": "post_admin_llm_test_v1_admin_llm_test_post", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Admin Llm Test V1 Admin Llm Test Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/llm/metrics": { "get": { "tags": [ "copilot" ], "summary": "Get Admin Llm Metrics", "description": "In-process copilot/LLM usage counters (admin only).", "operationId": "get_admin_llm_metrics_v1_admin_llm_metrics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Get Admin Llm Metrics V1 Admin Llm Metrics Get" } } } } } } }, "/v1/copilot/chat": { "post": { "tags": [ "copilot" ], "summary": "Post Copilot Chat", "operationId": "post_copilot_chat_v1_copilot_chat_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Copilot Chat V1 Copilot Chat Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/chat/stream": { "post": { "tags": [ "copilot" ], "summary": "Post Copilot Chat Stream", "description": "Server-sent events: each line is ``data: `` with types ``delta``, ``status``,\n``error``, and ``done``. Client should accumulate ``delta`` text for the assistant message.", "operationId": "post_copilot_chat_stream_v1_copilot_chat_stream_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/assist/import-mapping": { "post": { "tags": [ "copilot" ], "summary": "Post Copilot Assist Import Mapping", "description": "LLM-suggested column mapping for bulk import (read-only: returns JSON only).\nBody: ``targetResourceType`` (e.g. Device), ``columns`` (string[]), ``sampleRows`` (array of row objects, optional).", "operationId": "post_copilot_assist_import_mapping_v1_copilot_assist_import_mapping_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Copilot Assist Import Mapping V1 Copilot Assist Import Mapping Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/assist/ticket-triage": { "post": { "tags": [ "copilot" ], "summary": "Post Copilot Assist Ticket Triage", "description": "Pasted ticket/incident: extract hostnames/IPs, search inventory; optional LLM summary.\nBody: ``text`` (string), ``summarize`` (optional bool, default true if LLM available).", "operationId": "post_copilot_assist_ticket_triage_v1_copilot_assist_ticket_triage_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Copilot Assist Ticket Triage V1 Copilot Assist Ticket Triage Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/suggest_thread_title": { "post": { "tags": [ "copilot" ], "summary": "Post Suggest Thread Title", "description": "Suggest a short display title for a chat after the first user+assistant turn.\nReturns { \"title\": str | null }; null if LLM is unavailable or generation fails.", "operationId": "post_suggest_thread_title_v1_copilot_suggest_thread_title_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Suggest Thread Title V1 Copilot Suggest Thread Title Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/suggest_next_steps": { "post": { "tags": [ "copilot" ], "summary": "Post Suggest Next Steps", "description": "Three \u201cwhere to go next\u201d chip options: current app page (server-enriched) plus recent chat.\nUses the LLM when configured; otherwise (or if the model returns empty or unparseable JSON) returns\ndeterministic `suggestions` so the UI always has follow-ups to show.", "operationId": "post_suggest_next_steps_v1_copilot_suggest_next_steps_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Post Suggest Next Steps V1 Copilot Suggest Next Steps Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/suggestions": { "get": { "tags": [ "copilot" ], "summary": "Get Copilot Suggestions", "operationId": "get_copilot_suggestions_v1_copilot_suggestions_get", "parameters": [ { "name": "resourceType", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resourcetype" } }, { "name": "route", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Route" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Copilot Suggestions V1 Copilot Suggestions Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/skills": { "get": { "tags": [ "copilot" ], "summary": "List Skills", "operationId": "list_skills_v1_copilot_skills_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Skills V1 Copilot Skills Get" } } } } } }, "post": { "tags": [ "copilot" ], "summary": "Create Skill", "operationId": "create_skill_v1_copilot_skills_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response Create Skill V1 Copilot Skills Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/copilot/skills/{skill_id}": { "patch": { "tags": [ "copilot" ], "summary": "Patch Skill", "operationId": "patch_skill_v1_copilot_skills__skill_id__patch", "parameters": [ { "name": "skill_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Skill Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Skill V1 Copilot Skills Skill Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "copilot" ], "summary": "Delete Skill", "operationId": "delete_skill_v1_copilot_skills__skill_id__delete", "parameters": [ { "name": "skill_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Skill Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/internal/llm/complete": { "post": { "tags": [ "internal" ], "summary": "Post Internal Llm Complete", "description": "Text-only completion using the target org's effective LLM (no tools). For workers and extension runtimes.\nHeaders: ``X-Nims-Internal-Key``, ``X-Organization-Id`` (UUID).\nBody: ``{ \"messages\": [ { \"role\": \"system\"|\"user\"|\"assistant\", \"content\": \"...\" } ], \"maxTokens\"?: int, \"temperature\"?: float }``", "operationId": "post_internal_llm_complete_v1_internal_llm_complete_post", "parameters": [ { "name": "X-Nims-Internal-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Nims-Internal-Key" } }, { "name": "X-Organization-Id", "in": "header", "required": true, "schema": { "type": "string", "title": "X-Organization-Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Post Internal Llm Complete V1 Internal Llm Complete Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/plugin-placements": { "get": { "tags": [ "extensions-admin" ], "summary": "List Placements", "operationId": "list_placements_v1_admin_plugin_placements_get", "parameters": [ { "name": "pageId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pageid" } }, { "name": "includeDisabled", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Includedisabled" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "title": "Response List Placements V1 Admin Plugin Placements Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "extensions-admin" ], "summary": "Create Placement", "operationId": "create_placement_v1_admin_plugin_placements_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create Placement V1 Admin Plugin Placements Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/admin/plugin-placements/{placement_id}": { "patch": { "tags": [ "extensions-admin" ], "summary": "Patch Placement", "operationId": "patch_placement_v1_admin_plugin_placements__placement_id__patch", "parameters": [ { "name": "placement_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Placement Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Patch Placement V1 Admin Plugin Placements Placement Id Patch" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "extensions-admin" ], "summary": "Delete Placement", "operationId": "delete_placement_v1_admin_plugin_placements__placement_id__delete", "parameters": [ { "name": "placement_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Placement Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/location-type": { "get": { "tags": [ "validation" ], "summary": "Validate Location Type", "operationId": "validate_location_type_v1_validation_location_type_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "`LocationType.id` in the global catalog", "title": "Id" }, "description": "`LocationType.id` in the global catalog" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Location Type V1 Validation Location Type Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/location": { "get": { "tags": [ "validation" ], "summary": "Validate Location", "operationId": "validate_location_v1_validation_location_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Org-scoped `Location.id`", "title": "Id" }, "description": "Org-scoped `Location.id`" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Location V1 Validation Location Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/rack": { "get": { "tags": [ "validation" ], "summary": "Validate Rack", "operationId": "validate_rack_v1_validation_rack_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Org-scoped `Rack.id`", "title": "Id" }, "description": "Org-scoped `Rack.id`" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Rack V1 Validation Rack Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/device-type": { "get": { "tags": [ "validation" ], "summary": "Validate Device Type", "operationId": "validate_device_type_v1_validation_device_type_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "`DeviceType.id` in the global catalog", "title": "Id" }, "description": "`DeviceType.id` in the global catalog" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Device Type V1 Validation Device Type Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/device-role": { "get": { "tags": [ "validation" ], "summary": "Validate Device Role", "operationId": "validate_device_role_v1_validation_device_role_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "`DeviceRole.id` in the global catalog", "title": "Id" }, "description": "`DeviceRole.id` in the global catalog" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Device Role V1 Validation Device Role Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/interface": { "get": { "tags": [ "validation" ], "summary": "Validate Interface", "operationId": "validate_interface_v1_validation_interface_get", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "description": "Interface id (must belong to a device in your org)", "title": "Id" }, "description": "Interface id (must belong to a device in your org)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Interface V1 Validation Interface Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/validation/cable-ends": { "get": { "tags": [ "validation" ], "summary": "Validate Cable Endpoints", "description": "Check both cable endpoints in one round trip (org scope + interface existence).", "operationId": "validate_cable_endpoints_v1_validation_cable_ends_get", "parameters": [ { "name": "interfaceAId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Interfaceaid" } }, { "name": "interfaceBId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Interfacebid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Validate Cable Endpoints V1 Validation Cable Ends Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/graphql": { "get": { "summary": "Handle Http Get", "operationId": "handle_http_get_graphql_get", "parameters": [ { "name": "request", "in": "query", "required": true, "schema": { "title": "Request" } } ], "responses": { "200": { "description": "The GraphiQL integrated development environment.", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Not found if GraphiQL or query via GET are not enabled." }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "summary": "Handle Http Post", "operationId": "handle_http_post_graphql_post", "parameters": [ { "name": "request", "in": "query", "required": true, "schema": { "title": "Request" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/app": { "get": { "summary": "Redirect App", "operationId": "redirect_app_app_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/": { "get": { "summary": "Redirect Root", "operationId": "redirect_root__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/app/": { "get": { "summary": "App Index", "operationId": "app_index_app__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/app/{full_path}": { "get": { "summary": "App Spa", "operationId": "app_spa_app__full_path__get", "parameters": [ { "name": "full_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Full Path" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "Body_bulk_import_csv_v1_bulk__resource_type__import_csv_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_bulk_import_csv_v1_bulk__resource_type__import_csv_post" }, "BulkJsonImportBody": { "properties": { "rows": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Rows" }, "skipErrors": { "type": "boolean", "title": "Skiperrors", "default": false } }, "type": "object", "title": "BulkJsonImportBody" }, "CableCreate": { "properties": { "interfaceAId": { "type": "string", "format": "uuid", "title": "Interfaceaid" }, "interfaceBId": { "type": "string", "format": "uuid", "title": "Interfacebid" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "required": [ "interfaceAId", "interfaceBId" ], "title": "CableCreate" }, "ChangeRequestCreate": { "properties": { "title": { "type": "string", "minLength": 1, "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" } }, "type": "object", "required": [ "title", "payload" ], "title": "ChangeRequestCreate" }, "CircuitCreate": { "properties": { "providerId": { "type": "string", "format": "uuid", "title": "Providerid" }, "cid": { "type": "string", "minLength": 1, "title": "Cid" }, "bandwidthMbps": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Bandwidthmbps" }, "status": { "anyOf": [ { "type": "string", "enum": [ "PLANNED", "ACTIVE", "DECOMMISSIONED" ] }, { "type": "null" } ], "title": "Status" }, "aSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asidenotes" }, "zSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zsidenotes" }, "circuitDiversityGroupId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Circuitdiversitygroupid" } }, "type": "object", "required": [ "providerId", "cid" ], "title": "CircuitCreate" }, "CircuitSegmentCreate": { "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "segmentIndex": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Segmentindex" }, "providerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Providerid" }, "bandwidthMbps": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Bandwidthmbps" }, "status": { "anyOf": [ { "type": "string", "enum": [ "PLANNED", "ACTIVE", "DECOMMISSIONED" ] }, { "type": "null" } ], "title": "Status" }, "aSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asidenotes" }, "zSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zsidenotes" } }, "type": "object", "title": "CircuitSegmentCreate", "description": "Add a leg to a multi-segment circuit. Omit segmentIndex to append after the last leg." }, "CircuitUpdate": { "properties": { "providerId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Providerid" }, "cid": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Cid" }, "bandwidthMbps": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Bandwidthmbps" }, "status": { "anyOf": [ { "type": "string", "enum": [ "PLANNED", "ACTIVE", "DECOMMISSIONED" ] }, { "type": "null" } ], "title": "Status" }, "aSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Asidenotes" }, "zSideNotes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zsidenotes" }, "circuitDiversityGroupId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Circuitdiversitygroupid" } }, "type": "object", "title": "CircuitUpdate" }, "ConnectorCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "type": { "type": "string", "minLength": 1, "title": "Type", "description": "e.g. webhook_outbound, http_get, generic_rest" }, "pluginRegistrationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Pluginregistrationid" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "settings": { "additionalProperties": true, "type": "object", "title": "Settings" }, "credentials": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Credentials" } }, "type": "object", "required": [ "name", "type" ], "title": "ConnectorCreate" }, "ConnectorTestBody": { "properties": { "connectorId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Connectorid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "credentials": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Credentials" }, "pluginRegistrationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Pluginregistrationid" } }, "type": "object", "title": "ConnectorTestBody", "description": "Test an existing registration or a draft (unsaved) connector configuration." }, "ConnectorUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "type": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Type" }, "pluginRegistrationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Pluginregistrationid" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Settings" }, "credentials": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Credentials" } }, "type": "object", "title": "ConnectorUpdate" }, "DeviceCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "Display name (non-empty)." }, "deviceTypeId": { "type": "string", "format": "uuid", "title": "Devicetypeid", "description": "`DeviceType` in the global catalog (manufacturer + model).", "x-referential": "device_type", "x-validation-endpoint": "/v1/validation/device-type" }, "deviceRoleId": { "type": "string", "format": "uuid", "title": "Deviceroleid", "description": "`DeviceRole` in the global catalog.", "x-referential": "device_role", "x-validation-endpoint": "/v1/validation/device-role" }, "rackId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Rackid", "description": "Optional org-scoped rack placement.", "x-referential": "rack", "x-validation-endpoint": "/v1/validation/rack" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serialnumber" }, "positionU": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Positionu", "description": "Rack unit position, when racked." }, "face": { "anyOf": [ { "type": "string", "enum": [ "front", "rear" ] }, { "type": "null" } ], "title": "Face", "description": "Mount face when racked." }, "status": { "anyOf": [ { "type": "string", "enum": [ "PLANNED", "STAGED", "ACTIVE", "DECOMMISSIONED" ] }, { "type": "null" } ], "title": "Status", "description": "Lifecycle status; server defaults to PLANNED if omitted on create." }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "required": [ "name", "deviceTypeId", "deviceRoleId" ], "title": "DeviceCreate" }, "DeviceUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Display name (non-empty)." }, { "type": "null" } ], "title": "Name" }, "deviceTypeId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Devicetypeid", "x-referential": "device_type", "x-validation-endpoint": "/v1/validation/device-type" }, "deviceRoleId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Deviceroleid", "x-referential": "device_role", "x-validation-endpoint": "/v1/validation/device-role" }, "rackId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Rackid", "x-referential": "rack", "x-validation-endpoint": "/v1/validation/rack" }, "serialNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serialnumber" }, "positionU": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Positionu" }, "face": { "anyOf": [ { "type": "string", "enum": [ "front", "rear" ] }, { "type": "null" } ], "title": "Face" }, "status": { "anyOf": [ { "type": "string", "enum": [ "PLANNED", "STAGED", "ACTIVE", "DECOMMISSIONED" ] }, { "type": "null" } ], "title": "Status" }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "title": "DeviceUpdate" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "IdentityTestRequest": { "properties": { "target": { "type": "string", "enum": [ "ldap", "azure_ad", "oidc" ], "title": "Target", "description": "Directory to probe: bind for LDAP, OpenID metadata for Entra and OIDC." }, "overrides": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Overrides", "description": "Unsaved form values (same key names as PATCH for that provider; merged with stored when not env-locked)." } }, "type": "object", "required": [ "target" ], "title": "IdentityTestRequest" }, "InterfaceCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "Display name (non-empty)." }, "type": { "type": "string", "title": "Type", "default": "ethernet" }, "macAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Macaddress" }, "mtu": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mtu" } }, "type": "object", "required": [ "name" ], "title": "InterfaceCreate" }, "IpAddressCreate": { "properties": { "prefixId": { "type": "string", "format": "uuid", "title": "Prefixid" }, "address": { "type": "string", "minLength": 1, "title": "Address" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "interfaceId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Interfaceid" } }, "type": "object", "required": [ "prefixId", "address" ], "title": "IpAddressCreate" }, "IpAddressUpdate": { "properties": { "prefixId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Prefixid" }, "address": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Address" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "interfaceId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Interfaceid" } }, "type": "object", "title": "IpAddressUpdate" }, "JobCreate": { "properties": { "key": { "type": "string", "minLength": 1, "title": "Key" }, "name": { "type": "string", "minLength": 1, "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "requiresApproval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requiresapproval" } }, "type": "object", "required": [ "key", "name" ], "title": "JobCreate" }, "JobDefinitionUpdate": { "properties": { "key": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Key" }, "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "requiresApproval": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Requiresapproval" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, "type": "object", "title": "JobDefinitionUpdate" }, "JobRunBody": { "properties": { "input": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input" }, "idempotencyKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotencykey" } }, "type": "object", "title": "JobRunBody" }, "LocationCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "Display name (non-empty)." }, "slug": { "type": "string", "minLength": 1, "title": "Slug", "description": "URL-style slug (non-empty)." }, "locationTypeId": { "type": "string", "format": "uuid", "title": "Locationtypeid", "description": "Reference to a `LocationType` row (global catalog).", "x-referential": "location_type", "x-validation-endpoint": "/v1/validation/location-type" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parentid", "description": "Parent location in the org hierarchy, if any.", "x-referential": "location", "x-validation-endpoint": "/v1/validation/location" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "latitude": { "anyOf": [ { "type": "number", "maximum": 90.0, "minimum": -90.0 }, { "type": "null" } ], "title": "Latitude", "description": "WGS84; must be paired with longitude." }, "longitude": { "anyOf": [ { "type": "number", "maximum": 180.0, "minimum": -180.0 }, { "type": "null" } ], "title": "Longitude", "description": "WGS84; must be paired with latitude." }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "required": [ "name", "slug", "locationTypeId" ], "title": "LocationCreate" }, "LocationUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Display name (non-empty)." }, { "type": "null" } ], "title": "Name", "description": "Omit to leave unchanged." }, "slug": { "anyOf": [ { "type": "string", "minLength": 1, "description": "URL-style slug (non-empty)." }, { "type": "null" } ], "title": "Slug", "description": "Omit to leave unchanged." }, "locationTypeId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Locationtypeid", "description": "`LocationType` id when changing the type.", "x-referential": "location_type", "x-validation-endpoint": "/v1/validation/location-type" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parentid", "description": "Re-parent within the org.", "x-referential": "location", "x-validation-endpoint": "/v1/validation/location" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "latitude": { "anyOf": [ { "type": "number", "maximum": 90.0, "minimum": -90.0 }, { "type": "null" } ], "title": "Latitude" }, "longitude": { "anyOf": [ { "type": "number", "maximum": 180.0, "minimum": -180.0 }, { "type": "null" } ], "title": "Longitude" }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "title": "LocationUpdate" }, "LoginBody": { "properties": { "email": { "type": "string", "minLength": 3, "title": "Email" }, "password": { "type": "string", "minLength": 1, "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginBody" }, "MePasswordBody": { "properties": { "currentPassword": { "type": "string", "minLength": 1, "title": "Currentpassword" }, "newPassword": { "type": "string", "maxLength": 256, "minLength": 8, "title": "Newpassword" } }, "type": "object", "required": [ "currentPassword", "newPassword" ], "title": "MePasswordBody" }, "MePatchBody": { "properties": { "preferences": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Preferences" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" } }, "type": "object", "title": "MePatchBody" }, "ObservedStateBody": { "properties": { "kind": { "type": "string", "enum": [ "DEVICE", "INTERFACE", "SERVICE" ], "title": "Kind" }, "deviceId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Deviceid" }, "lastSeenAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Lastseenat" }, "health": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Health" }, "payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Payload" }, "driftDetected": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Driftdetected" }, "driftSummary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Driftsummary" } }, "type": "object", "required": [ "kind" ], "title": "ObservedStateBody" }, "PlacementCreate": { "properties": { "pluginRegistrationId": { "type": "string", "format": "uuid", "title": "Pluginregistrationid" }, "pageId": { "type": "string", "minLength": 1, "title": "Pageid" }, "slot": { "type": "string", "minLength": 1, "title": "Slot" }, "widgetKey": { "type": "string", "minLength": 1, "title": "Widgetkey" }, "priority": { "type": "integer", "title": "Priority", "default": 0 }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "macroBindings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Macrobindings" }, "requiredPermissions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Requiredpermissions" } }, "type": "object", "required": [ "pluginRegistrationId", "pageId", "slot", "widgetKey" ], "title": "PlacementCreate" }, "PlacementUpdate": { "properties": { "pageId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Pageid" }, "slot": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Slot" }, "widgetKey": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Widgetkey" }, "priority": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Priority" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "macroBindings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Macrobindings" }, "requiredPermissions": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Requiredpermissions" } }, "type": "object", "title": "PlacementUpdate" }, "PrefixCreate": { "properties": { "vrfId": { "type": "string", "format": "uuid", "title": "Vrfid" }, "cidr": { "type": "string", "minLength": 1, "title": "Cidr" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parentid" } }, "type": "object", "required": [ "vrfId", "cidr" ], "title": "PrefixCreate" }, "PrefixUpdate": { "properties": { "vrfId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Vrfid" }, "cidr": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Cidr" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "parentId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parentid" } }, "type": "object", "title": "PrefixUpdate" }, "ProviderCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "asn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Asn" } }, "type": "object", "required": [ "name" ], "title": "ProviderCreate" }, "ProviderUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "asn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Asn" } }, "type": "object", "title": "ProviderUpdate" }, "RackCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name", "description": "Display name (non-empty)." }, "locationId": { "type": "string", "format": "uuid", "title": "Locationid", "description": "Rack is placed in this org-scoped location.", "x-referential": "location", "x-validation-endpoint": "/v1/validation/location" }, "uHeight": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Uheight", "description": "Rack height in U; defaults to 42 on the server if omitted." }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "required": [ "name", "locationId" ], "title": "RackCreate" }, "RackUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1, "description": "Display name (non-empty)." }, { "type": "null" } ], "title": "Name" }, "locationId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Locationid", "description": "Relocate the rack to another site/room.", "x-referential": "location", "x-validation-endpoint": "/v1/validation/location" }, "uHeight": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Uheight" }, "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "title": "RackUpdate" }, "ResourceExtensionPut": { "properties": { "templateId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Templateid" }, "customAttributes": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Customattributes" } }, "type": "object", "title": "ResourceExtensionPut" }, "ServiceCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "serviceType": { "type": "string", "minLength": 1, "title": "Servicetype" }, "customerRef": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customerref" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "name", "serviceType" ], "title": "ServiceCreate" }, "ServiceUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "serviceType": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Servicetype" }, "customerRef": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customerref" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "title": "ServiceUpdate" }, "TemplateCreate": { "properties": { "resourceType": { "type": "string", "minLength": 1, "title": "Resourcetype" }, "name": { "type": "string", "minLength": 1, "title": "Name" }, "slug": { "type": "string", "minLength": 1, "pattern": "^[a-z0-9][a-z0-9_-]*$", "title": "Slug" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "definition": { "additionalProperties": true, "type": "object", "title": "Definition" }, "isDefault": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isdefault", "default": false } }, "type": "object", "required": [ "resourceType", "name", "slug", "definition" ], "title": "TemplateCreate" }, "TemplateUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "definition": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Definition" }, "isDefault": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isdefault" } }, "type": "object", "title": "TemplateUpdate" }, "TokenCreateBody": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "role": { "type": "string", "enum": [ "READ", "WRITE", "ADMIN" ], "title": "Role", "default": "WRITE" } }, "type": "object", "required": [ "name" ], "title": "TokenCreateBody" }, "UserCreateBody": { "properties": { "email": { "type": "string", "maxLength": 320, "minLength": 3, "title": "Email" }, "displayName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Displayname" }, "role": { "type": "string", "enum": [ "READ", "WRITE", "ADMIN" ], "title": "Role", "default": "READ" }, "password": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 8 }, { "type": "null" } ], "title": "Password" } }, "type": "object", "required": [ "email" ], "title": "UserCreateBody" }, "UserPatchBody": { "properties": { "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Displayname" }, "role": { "anyOf": [ { "type": "string", "enum": [ "READ", "WRITE", "ADMIN" ] }, { "type": "null" } ], "title": "Role" }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isactive" } }, "type": "object", "title": "UserPatchBody" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VlanCreate": { "properties": { "vid": { "type": "integer", "maximum": 4094.0, "minimum": 1.0, "title": "Vid" }, "name": { "type": "string", "minLength": 1, "title": "Name" }, "vlanGroupId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Vlangroupid" } }, "type": "object", "required": [ "vid", "name" ], "title": "VlanCreate" }, "VlanUpdate": { "properties": { "vid": { "anyOf": [ { "type": "integer", "maximum": 4094.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Vid" }, "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "vlanGroupId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Vlangroupid" } }, "type": "object", "title": "VlanUpdate" }, "VrfCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "rd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rd" } }, "type": "object", "required": [ "name" ], "title": "VrfCreate" }, "VrfUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "rd": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rd" } }, "type": "object", "title": "VrfUpdate" }, "WebhookCreateBody": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url" }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Secret" }, "resourceTypes": { "items": { "type": "string" }, "type": "array", "title": "Resourcetypes" }, "events": { "items": { "type": "string", "enum": [ "CREATE", "UPDATE", "DELETE" ] }, "type": "array", "minItems": 1, "title": "Events" } }, "type": "object", "required": [ "name", "url", "events" ], "title": "WebhookCreateBody" } } } }