{ "openapi": "3.0.0", "info": { "version": "3.0.0", "title": "VNS3:ms API", "description": "The VNS3 Management System is a single dashboard for full visibility into your Cloud Area Network. Manage, monitor and automate your firewall policies, network access, backups and more.\n", "termsOfService": "https://www.cohesive.net/legal-disclaimer", "contact": { "name": "Cohesive Networks Support team", "email": "support@cohesive.net", "url": "https://support.cohesive.net" }, "x-origin": [ { "format": "openapi", "url": "https://cohesive-networks.s3.amazonaws.com/apis/vns3-ms/vns3ms-v2.3.5.oasv3.json", "version": "3.0" } ], "x-preferred": true, "x-providerName": "cohesive.net" }, "security": [ { "ApiTokenAuth": [] } ], "servers": [ { "url": "https://vns3ms-host:8000/api" } ], "tags": [ { "name": "Access", "description": "Provision API keys or short-lived access URLs for providing temporary access to any VNS3 controller in your topology\n" }, { "name": "Administration", "description": "Configure VNS3:ms administration settings such as LDAP integration" }, { "name": "VNS3 Management", "description": "Manage VNS3 controllers in your network topology, automating\nsnapshots, HA and more" }, { "name": "Cloud Monitoring", "description": "Configure and monitor your cloud by tracking cloud VPCs and virtual\nnetworks" }, { "name": "Backups", "description": "Configure backups for VNS3:ms and your controller snapshots" }, { "name": "System", "description": "System configuration such as SSL, NTP hosts and remote support" }, { "name": "Users", "description": "User management endpoints for configuring credentials" } ], "paths": { "/auth": { "post": { "description": "API login method. Accept API-key as password, return API-token to be used for all other calls\n", "summary": "Create API Token", "operationId": "postCreateToken", "security": [], "x-sdk-module": "access", "tags": [ "Access" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "CreateAuthTokenRequest", "type": "object", "required": [ "username", "api_key" ], "properties": { "username": { "description": "Username for API key", "type": "string" }, "api_key": { "description": "Enabled User API key to generate token with", "type": "string" } } }, "example": { "username": "admin", "api_key": "bdfac681b375e4306b8cd3280b440890d82378147c41fcc8e" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "title": "ApiTokenResponse", "type": "object", "properties": { "api_token": { "type": "string" } }, "example": { "api_token": "bdfac681b375e4306b8cd3280b440890d82378147c41fcc8e" } } } } }, "401": { "description": "Authentication information missing or invalid", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "string" } }, "example": { "response_type": "error", "response": "401 Unauthorised. Invalid or expired token" } } } } } } } }, "/auth/activate": { "put": { "description": "Activate the default API key", "summary": "Activate API key", "operationId": "putActivateApiKey", "x-sdk-module": "access", "security": [], "tags": [ "Access" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "putActivateApiKeyRequest", "type": "object", "required": [ "username", "api_key" ], "properties": { "username": { "description": "Username for default API Key", "type": "string" }, "api_key": { "type": "string" } } }, "example": { "username": "admin", "api_key": "1802fb5283e35e65b4cf7d4dfa5a115917" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "message": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "api_key": { "type": "string" }, "active_tokens": { "type": "integer" }, "enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "message": "Key activated", "name": "Admin Key", "api_key": "1802fb5283e35e65b4cf7d4dfa5a115917", "id": 10, "enabled": true, "active_tokens": 0 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/auth/expire_token": { "put": { "description": "Expire current token to log out of API session", "summary": "Expire current token", "operationId": "putExpireToken", "x-sdk-module": "access", "tags": [ "Access" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "SimpleObjectMessageResponse", "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "message": { "type": "string" } } } } }, "example": { "response_type": "success", "response": { "message": "Successfully expired token" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/auth/invalidate_tokens": { "put": { "description": "Invalidate API key Tokens", "summary": "Invalidate API Key tokens", "operationId": "putInvalidateApiKeyTokens", "x-sdk-module": "access", "tags": [ "Access" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "InvalidateApiKeyTokensRequest", "type": "object", "required": [ "api_key_id" ], "properties": { "api_key_id": { "description": "API Key id", "type": "integer" } } }, "example": { "api_key_id": 4 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "message": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "integer" }, "active_tokens": { "type": "integer" }, "enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "message": "Invalidated 4 tokens", "id": 2, "enabled": true, "active_tokens": 0, "name": "API Key" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/auth/api_keys": { "get": { "description": "Get API keys", "summary": "Get API keys", "operationId": "getApiKeys", "x-sdk-module": "access", "tags": [ "Access" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "default_key": { "type": "boolean" }, "active_tokens": { "type": "integer", "description": "Number of valid tokens in use" }, "expired_tokens": { "type": "integer", "description": "Number of expired tokens" }, "last_access_time": { "type": "string", "format": "date-time", "description": "The last time a token for this API key was used" }, "last_access_ip": { "type": "string", "description": "The last IP address to use this API key or an API token for this\napi key" } } } } } }, "example": { "response_type": "success", "response": [ { "id": 3, "name": "AdminKey", "enabled": true, "created_at": "2019-01-06T19:02:40.000Z", "default_key": false, "active_tokens": 1, "expired_tokens": 10, "last_access_time": "2020-03-06T12:02:14.000Z", "last_access_ip": "34.89.10.21" } ] } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/auth/api_key": { "post": { "description": "Create new API Key", "summary": "Create API Key", "operationId": "postCreateApiKey", "x-sdk-module": "access", "tags": [ "Access" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "CreateApiKeyRequest", "type": "object", "required": [ "key_name" ], "properties": { "key_name": { "description": "Name or description of API key", "type": "string" } } }, "example": { "key_name": "Jenkins API Key" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1activate/put/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "message": "Key created", "name": "Jenkins API Key", "api_key": "a7df7d7fbd0eae80e537382aabf", "id": 4, "active_tokens": 0, "enabled": true } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/auth/api_key/{key_id}": { "put": { "description": "Update Existing API Key", "summary": "Update API Key", "operationId": "putUpdateApiKey", "x-sdk-module": "access", "tags": [ "Access" ], "parameters": [ { "name": "key_id", "in": "path", "description": "API Key ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "UpdateApiKeyRequest", "type": "object", "required": [ "key_name", "enabled" ], "properties": { "key_name": { "description": "New name for API key", "type": "string" }, "enabled": { "description": "Enable/Disable API Key", "type": "boolean" } } }, "example": { "key_name": "My New Name", "enabled": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "message": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "active_tokens": { "type": "integer" }, "enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "message": "Key updated", "name": "My New Name", "id": 4, "enabled": true, "active_tokens": 0 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "delete": { "description": "Delete API Key", "summary": "Delete API Key", "operationId": "deleteApiKey", "x-sdk-module": "access", "tags": [ "Access" ], "parameters": [ { "name": "key_id", "in": "path", "description": "API Key ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "SimpleStringResponse", "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "string" } } }, "example": { "response_type": "success", "response": "Deleted key" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "string" } }, "example": { "response_type": "error", "response": "Missing resource" } } } } } } } }, "/admin/ldap": { "put": { "description": "Enable/Disable LDAP", "summary": "Enable/Disable LDAP", "operationId": "putEnableLdap", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "putEnableLdapRequest", "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } } }, "example": { "enabled": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "ldap_enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "ldap_enabled": true } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/admin/ldap/settings": { "get": { "description": "Get LDAP Settings", "summary": "Get LDAP Settings", "operationId": "getLdapSettings", "x-sdk-module": "admin", "tags": [ "Administration" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "ldap_host": { "nullable": true, "type": "string" }, "ldap_port": { "nullable": true, "type": "integer" }, "ldap_ssl": { "nullable": true, "type": "boolean" }, "ldap_binddn": { "nullable": true, "type": "string" }, "ldap_bindpw": { "nullable": true, "type": "string" } } } } }, "example": { "response_type": "success", "response": { "ldap_host": "4.4.4.4", "ldap_port": 389, "ldap_ssl": false, "ldap_binddn": "abcdef", "ldap_bindpw": "ghijklmn" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "put": { "description": "Update LDAP connection configuration settings", "summary": "Update LDAP settings", "operationId": "putLdapSettings", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "putLdapSettingsRequest", "type": "object", "required": [ "ldap_host" ], "properties": { "ldap_host": { "description": "Host for LDAP server, IP or DNS", "type": "string" }, "ldap_port": { "description": "Port for LDAP server", "type": "integer", "default": 389 }, "ldap_ssl": { "description": "Use SSL?", "type": "boolean" }, "ldap_binddn": { "description": "Bind Username", "type": "string" }, "ldap_bindpw": { "description": "Bind password", "type": "string" } } }, "example": { "ldap_host": "my.ldapserver.com", "ldap_binddn": "BindUsername", "ldap_bindpw": "x1oinoa1212d" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Settings updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Validate LDAP connection settings", "summary": "Validate LDAP settings", "operationId": "postValidateLdapSettings", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postValidateLdapSettingsRequest", "type": "object", "required": [ "ldap_host" ], "properties": { "ldap_host": { "description": "Host for LDAP server, IP or DNS", "type": "string" }, "ldap_port": { "description": "Port for LDAP server", "type": "integer", "default": 389 }, "ldap_ssl": { "description": "Use SSL?", "type": "boolean" }, "ldap_binddn": { "description": "Bind Username", "type": "string" }, "ldap_bindpw": { "description": "Bind password", "type": "string" } } }, "example": { "ldap_host": "my.ldapserver.com", "ldap_binddn": "BindUsername", "ldap_bindpw": "x1oinoa1212d" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "connect_success": { "type": "boolean" }, "message": { "type": "string" } } } } }, "example": { "response_type": "success", "response": { "connect_success": true } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/paths/~1admin~1ldap~1settings/post/responses/200/content/application~1json/schema" }, "example": { "response_type": "error", "response": { "connect_success": false, "message": "Failed to bind with username" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/admin/ldap/user_schema": { "get": { "description": "Get LDAP user schema Settings", "summary": "Get LDAP user schema", "operationId": "getLdapUserSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "ldap_user_base": { "description": "Base DN from which to search for Users", "type": "string" }, "ldap_user_id_attribute": { "description": "Attribute type for the Users", "type": "string" }, "ldap_user_list_filter": { "nullable": true, "description": "Search filter for Users", "type": "string" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "put": { "description": "Set LDAP user schema settings", "summary": "Set LDAP user schema settings", "operationId": "putLdapUserSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "putLdapUserSchemaSettingsRequest", "type": "object", "required": [ "ldap_user_base", "ldap_user_id_attribute" ], "properties": { "ldap_user_base": { "description": "Base DN from which to search for Users", "type": "string" }, "ldap_user_id_attribute": { "description": "Attribute type for the Users", "type": "string" }, "ldap_user_list_filter": { "description": "Search filter for Users", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "LDAP user schema settings updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Validate LDAP user schema settings by retrieving data", "summary": "Validate LDAP user schema", "operationId": "postValidateLdapUserSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postValidateLdapUserSchemaRequest", "type": "object", "required": [ "ldap_host" ], "properties": { "ldap_user_base": { "description": "Base DN from which to search for Users", "type": "string" }, "ldap_user_id_attribute": { "description": "Attribute type for the Users", "type": "string" }, "ldap_user_list_filter": { "description": "Search filter for Users", "type": "string" }, "limit": { "description": "Number of records to return. Default = 100", "type": "integer", "default": 100 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "SimpleStringListResponse", "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "string" } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/admin/ldap/group_schema": { "get": { "description": "Get LDAP group schema Settings", "summary": "Get LDAP group schema", "operationId": "getLdapGroupSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "ldap_group_required": { "type": "boolean" }, "ldap_group_base": { "description": "Base DN from which to search for Groups", "type": "string" }, "ldap_group_id_attribute": { "description": "Attribute type for the Groups", "type": "string" }, "ldap_group_list_filter": { "nullable": true, "description": "Search filter for Groups", "type": "string" }, "ldap_group_member_attribute": { "description": "Attribute used to search for a user within the Group", "type": "string" }, "ldap_group_member_attr_format": { "description": "Format of the Group Member attribute", "type": "string", "default": "UserDN" }, "ldap_search_scope": { "description": "Scope for search filter", "type": "string", "default": "subtree" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "put": { "description": "Set LDAP group schema settings", "summary": "Set LDAP group schema settings", "operationId": "putLdapGroupSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "putLdapGroupSchemaRequest", "type": "object", "required": [ "ldap_group_required", "ldap_group_base", "ldap_group_id_attribute", "ldap_group_member_attribute" ], "properties": { "ldap_group_required": { "description": "Require use of LDAP groups", "type": "boolean" }, "ldap_group_base": { "description": "Base DN from which to search for Groups", "type": "string" }, "ldap_group_id_attribute": { "description": "Attribute type for the Groups", "type": "string" }, "ldap_group_list_filter": { "description": "Search filter for Groups", "type": "string" }, "ldap_group_member_attribute": { "description": "Attribute used to search for a user within the Group", "type": "string" }, "ldap_group_member_attr_format": { "description": "Format of the Group Member attribute", "default": "UserDN", "type": "string" }, "ldap_search_scope": { "description": "Search filter for Groups", "type": "string", "default": "subtree" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "LDAP group schema settings updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Validate LDAP group schema settings by retrieving data", "summary": "Validate LDAP group schema", "operationId": "postValidateLdapGroupSchema", "x-sdk-module": "admin", "tags": [ "Administration" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postValidateLdapGroupSchemaRequest", "type": "object", "required": [ "ldap_group_base", "ldap_group_id_attribute", "ldap_group_member_attribute" ], "properties": { "ldap_group_base": { "description": "Base DN from which to search for Groups", "type": "string" }, "ldap_group_id_attribute": { "description": "Attribute type for the Groups", "type": "string" }, "ldap_group_list_filter": { "description": "Search filter for Groups", "type": "string" }, "ldap_group_member_attribute": { "description": "Attribute used to search for a user within the Group", "type": "string" }, "ldap_group_member_attr_format": { "description": "Format of the Group Member attribute", "type": "string", "default": "UserDN" }, "ldap_search_scope": { "description": "Scope for search", "type": "string", "default": "subtree" }, "limit": { "description": "Number of records to return. Default = 100", "type": "integer", "default": 100 } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1admin~1ldap~1user_schema/post/responses/200/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/backups": { "get": { "description": "Return a list of available database backup files", "summary": "Get backups", "operationId": "getBackups", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "backup_files": { "type": "array", "items": { "type": "object", "properties": { "backup_name": { "type": "string" }, "create_time": { "type": "string", "format": "date-time" }, "size": { "type": "integer" } } } }, "failed_backups": { "type": "array", "items": { "$ref": "#/paths/~1backups/get/responses/200/content/application~1json/schema/properties/response/properties/backup_files/items" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "delete": { "description": "Delete a backup file", "summary": "Delete Backup", "operationId": "deleteBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "requestBody": { "content": { "application/json": { "schema": { "title": "deleteBackupRequest", "type": "object", "required": [ "backup_name" ], "properties": { "backup_name": { "description": "Backup filename", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Backup file 'backup.file' deleted" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "title": "Error", "type": "object", "properties": { "response_type": { "type": "string", "default": "error" }, "response": { "type": "string" } } }, "example": { "response_type": "error", "response": "Missing backup file backup.file" } } } } } } }, "/backups/download": { "get": { "description": "Download a named backup file", "summary": "Download backup", "operationId": "getDownloadBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "parameters": [ { "in": "query", "name": "backup_name", "description": "Backup filename. Defaults to latest.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "File", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/backups/upload": { "post": { "description": "Upload a backup file", "summary": "Upload Backup", "operationId": "postUploadBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "requestBody": { "required": true, "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Backup file 'backup.file' uploaded" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "File exists" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/backups/create_backup": { "post": { "description": "Schedule a backup creation job", "summary": "Create Backup", "operationId": "postCreateBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "uuid": { "type": "string" }, "status": { "type": "string" }, "filename": { "type": "string" } } } } }, "example": { "response_type": "success", "response": { "status": "Backup process queued", "uuid": "abcasoidjf0q92039fnq039rfv0q93mv038" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/backups/create_backup/{uuid}": { "get": { "description": "Retrieve backup job status (DEPRECATED)", "summary": "Get Backup status", "operationId": "getBackupJob", "x-sdk-module": "backups", "tags": [ "Backups" ], "parameters": [ { "name": "uuid", "in": "path", "description": "Job UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "finished", "uuid": "abcasoidjf0q92039fnq039r", "filename": "backup.gz" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Unknown job UUID: abcasoidjf0q92039fnq039r" } } } } } } }, "/backups/restore_backup": { "post": { "description": "Restore a backup file, resetting the state of VNS3:ms", "summary": "Restore Backup", "operationId": "postRestoreBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postRestoreBackupRequest", "type": "object", "required": [ "backup_name" ], "properties": { "backup_name": { "description": "Backup filename", "type": "string" } } } } } }, "responses": { "201": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Backup restored" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing backup file backup.file" } } } } } } }, "/snapshots_backup": { "get": { "description": "Return details of snapshots backup", "summary": "Get snapshots backup", "operationId": "getSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "snapshot_backup_file": { "type": "object", "properties": { "backup_name": { "type": "string" }, "create_time": { "type": "string", "format": "date-time" }, "size": { "type": "integer" } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "delete": { "description": "Delete the snapshot backup file", "summary": "Delete Snapshot Backup", "operationId": "deleteSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Backup file 'backup.snapshots' deleted" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "No backup file" } } } } } } }, "/snapshots_backup/download": { "get": { "description": "Download the snapshots backup file", "summary": "Download snapshots backup", "operationId": "getDownloadSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "200": { "description": "File", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "No backup file" } } } } } } }, "/snapshots_backup/upload_backup": { "post": { "description": "Schedule a \"pull\" to retrieve a snapshots backup file from a\nspecified URI", "summary": "Upload Snapshot Backup", "operationId": "postUploadSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postUploadSnapshotsBackupRequest", "type": "object", "required": [ "url" ], "properties": { "url": { "description": "URL to download snapshot backup from", "type": "string" } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "Snapshots file retrieval queued", "uuid": "abcasoidjf0q92039fnq039rfv0q93mv038" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/snapshots_backup/upload_backup/{uuid}": { "get": { "description": "Retrieve snapshots backup retrieval job status (DEPRECATED)", "summary": "Get Snapshot Upload status", "operationId": "getSnapshotsUploadStatus", "x-sdk-module": "backups", "tags": [ "Backups" ], "parameters": [ { "name": "uuid", "in": "path", "description": "Job UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "in progress", "uuid": "abcasoidjf0q92039fnq039r", "filename": "backup.gz" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Unknown job UUID: abcasoidjf0q92039fnq039r" } } } } } } }, "/snapshots_backup/create_backup": { "post": { "description": "Schedule a snapshot backup creation", "summary": "Create Snapshot Backup", "operationId": "postCreateSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "Backup process queued", "uuid": "abcasoidjf0q92039fnq039rfv0q93mv038" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/snapshots_backup/create_backup/{uuid}": { "get": { "description": "Retrieve snapshot backup job status (DEPRECATED)", "summary": "Get Snapshot backup status", "operationId": "getSnapshotsBackupStatus", "x-sdk-module": "backups", "tags": [ "Backups" ], "parameters": [ { "name": "uuid", "in": "path", "description": "Job UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "in progress", "uuid": "abcasoidjf0q92039fnq039r", "filename": "backup.snapshots" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Unknown job UUID: abcasoidjf0q92039fnq039r" } } } } } } }, "/snapshots_backup/restore_backup": { "post": { "description": "Restore a snapshots backup file", "summary": "Restore Snapshots Backup", "operationId": "postRestoreSnapshotsBackup", "x-sdk-module": "backups", "tags": [ "Backups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "postRestoreSnapshotsBackupRequest", "type": "object", "required": [ "backup_name" ], "properties": { "backup_name": { "description": "Backup filename", "type": "string" } } } } } }, "responses": { "201": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Backup restored" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing backup file backup.snapshots" } } } } } } }, "/cloud_vlan_components": { "get": { "description": "Return list of all (accessible) Cloud VLAN Components", "summary": "Get VLAN Components", "operationId": "getCloudVlanComponents", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "cloud_vlan_component_id", "in": "query", "description": "Cloud VLAN Component ID for filtering", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "cloud_vlan_id": { "type": "integer" }, "cloud_vlan": { "type": "string" }, "cloud_cred_id": { "type": "integer" }, "cloud_type": { "type": "string" }, "region": { "type": "string" }, "description": { "nullable": true, "type": "string" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Create new Cloud VLAN Component", "summary": "Create VLAN component", "operationId": "postCreateVlanComponent", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateVlanComponentRequest", "type": "object", "required": [ "name", "cloud_vlan_id", "user_cred_id" ], "properties": { "name": { "description": "Cloud VLAN Component name", "type": "string" }, "cloud_vlan_id": { "description": "Parent Cloud VLAN ID", "type": "integer" }, "user_cred_id": { "description": "User credential ID", "type": "integer" }, "vlan_component_id": { "description": "Component ID defined by cloud associated with user credential", "type": "string" }, "region": { "description": "Cloud VLAN component region (EC2)", "type": "string" }, "description": { "description": "Component description", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "msg": { "type": "string" }, "id": { "type": "integer" } } } } }, "example": { "response_type": "success", "response": { "msg": "Cloud VLAN Component created", "id": 4 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN with ID 2 does not exist" } } } } } } }, "/cloud_vlan_components/{component_id}": { "get": { "description": "Return specific Cloud VLAN Components details", "summary": "Get VLAN Component", "operationId": "getCloudVlanComponent", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "component_id", "in": "path", "description": "VLAN component Id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "cloud_vlan_id": { "type": "integer" }, "cloud_vlan": { "type": "string" }, "cloud_cred_id": { "type": "integer" }, "cloud_type": { "type": "string" }, "region": { "type": "string" }, "description": { "nullable": true, "type": "string" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN Component with ID 4 does not exist" } } } } } }, "put": { "description": "Update specified Cloud VLAN Component", "summary": "Update VLAN component", "operationId": "putUpdateVlanComponent", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "component_id", "in": "path", "description": "VLAN component Id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateVlanComponentRequest", "type": "object", "properties": { "name": { "description": "Cloud VLAN Component name", "type": "string" }, "cloud_vlan_id": { "description": "Parent Cloud VLAN ID", "type": "integer" }, "user_cred_id": { "description": "User credential ID", "type": "integer" }, "region": { "description": "Cloud VLAN component region (EC2)", "type": "string" }, "description": { "description": "Component description", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Updated Cloud VLAN component" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN Component with ID 4 does not exist" } } } } } }, "delete": { "description": "Delete specified cloud VLAN Component", "summary": "Delete VLAN component", "operationId": "deleteVlanComponent", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "component_id", "in": "path", "description": "VLAN component Id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted Cloud VLAN Component 5" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN Component with ID 4 does not exist" } } } } } } }, "/cloud_vlans": { "get": { "description": "Return list of all (accessible) Cloud VLANs", "summary": "Get VLANs", "operationId": "getCloudVlans", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "cloud_vlan_id", "in": "query", "description": "Cloud VLAN ID for filtering", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "virtual_network_name": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "description": { "nullable": true, "type": "string" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Create new Cloud VLAN", "summary": "Create VLAN", "operationId": "postCreateCloudVlan", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateVlanRequest", "type": "object", "required": [ "name", "virtual_network_id" ], "properties": { "name": { "description": "Cloud VLAN name", "type": "string" }, "virtual_network_id": { "description": "Parent Virtual Network ID", "type": "integer" }, "description": { "description": "Component description", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1cloud_vlan_components/post/responses/201/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "msg": "Cloud VLAN created", "id": 2 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Virtual Network with ID 3 does not exist" } } } } } } }, "/cloud_vlans/{vlan_id}": { "get": { "description": "Return specific Cloud VLAN details", "summary": "Get VLAN", "operationId": "getCloudVlan", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vlan_id", "in": "path", "description": "VLAN ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "virtual_network_name": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "description": { "nullable": true, "type": "string" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN with ID 4 does not exist" } } } } } }, "put": { "description": "Update specified Cloud VLAN", "summary": "Update VLAN", "operationId": "putUpdateCloudVlan", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vlan_id", "in": "path", "description": "VLAN ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "postUpdateVlanRequest", "type": "object", "properties": { "name": { "description": "Cloud VLAN name", "type": "string" }, "virtual_network_id": { "description": "Parent Virtual Network ID", "type": "integer" }, "description": { "description": "Component description", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Updated Cloud VLAN" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN with ID 2 does not exist" } } } } } }, "delete": { "description": "Delete specified cloud VLAN", "summary": "Delete VLAN", "operationId": "deleteCloudVlan", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vlan_id", "in": "path", "description": "VLAN ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted Cloud VLAN 5" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Cloud VLAN with ID 5 does not exist" } } } } } } }, "/virtual_networks": { "get": { "description": "Return list of all (accessible) Virtual Networks", "summary": "Get Virtual Networks", "operationId": "getVirtualNetworks", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "virtual_network_id", "in": "query", "description": "Virtual network ID for filtering", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Create a new virtual network", "summary": "Create virtual network", "operationId": "postCreateVirtualNetwork", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateVirtualNetworkRequest", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Virtual Network name", "type": "string" }, "description": { "description": "Network description", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1cloud_vlan_components/post/responses/201/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "msg": "Virtual Network created", "id": 2 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/virtual_networks/{virtual_network_id}": { "get": { "description": "Return specific Virtual Network details", "summary": "Get Virtual Network", "operationId": "getVirtualNetwork", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "virtual_network_id", "in": "path", "description": "Virtual Network ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing Virtual Network with ID 10" } } } } } }, "put": { "description": "Update specified Virtual Network", "summary": "Update Virtual Network", "operationId": "putUpdateVirtualNetwork", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "virtual_network_id", "in": "path", "description": "Virtual Network ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateVirtualNetworkRequest", "type": "object", "properties": { "name": { "description": "Virtual Network name", "type": "string" }, "description": { "description": "Network description", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Updated Virtual Network" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing Virtual Network with ID 23" } } } } } }, "delete": { "description": "Delete virtual network", "summary": "Delete virtual network", "operationId": "deleteVirtualNetwork", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "virtual_network_id", "in": "path", "description": "Virtual Network ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted Virtual Network 12" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing Virtual Network with ID 99" } } } } } } }, "/virtual_networks/export": { "get": { "description": "Export virtual networks", "summary": "Export virtual networks", "operationId": "getExportVirtualNetworks", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "responses": { "200": { "description": "File vns3_network_export.csv", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/csv": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "No virtual networks to export" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/virtual_networks/import": { "post": { "description": "Import virtual networks from CSV file", "summary": "Import virtual networks", "operationId": "postImportVirtualNetworks", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "required": true, "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Import succeeded" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/vns3_topologies": { "get": { "description": "Return list of all (accessible) VNS3 Topologies", "summary": "Get VNS3 Topologies Networks", "operationId": "getVns3Topologies", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vns3_topology_id", "in": "query", "description": "VNS3 Topology ID for filtering", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "virtual_network_name": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "description": { "nullable": true, "type": "string" }, "vns3_controllers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Create a new VNS3 topology", "summary": "Create VNS3 topology", "operationId": "postCreateVns3Topology", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateVns3TopologyRequest", "type": "object", "required": [ "name", "virtual_network_id" ], "properties": { "name": { "description": "VNS3 Topology name", "type": "string" }, "virtual_network_id": { "description": "Parent Virtual Network ID", "type": "integer" }, "description": { "description": "Topology description", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1cloud_vlan_components/post/responses/201/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "msg": "VNS3 Topology created", "id": 29 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/vns3_topologies/{vns3_topology_id}": { "get": { "description": "Return specific VNS3 Topology details", "summary": "Get VNS3 Topology", "operationId": "getVns3Topology", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vns3_topology_id", "in": "path", "description": "VNS3 Topology ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "virtual_network_name": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "description": { "nullable": true, "type": "string" }, "vns3_controllers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing VNS3 Topology with ID 2" } } } } } }, "put": { "description": "Update specified VNS3 Topology", "summary": "Update VNS3 Topology", "operationId": "putUpdateVns3Topology", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vns3_topology_id", "in": "path", "description": "VNS3 Topology ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateVns3TopologyRequest", "type": "object", "properties": { "name": { "description": "VNS3 Topology name", "type": "string" }, "virtual_network_id": { "description": "Parent Virtual Network ID", "type": "integer" }, "description": { "description": "Topology description", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Updated VNS3 topology" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing VNS3 Topology with ID 2" } } } } } }, "delete": { "description": "Delete VNS3 Topology", "summary": "Delete VNS3 Topology", "operationId": "deleteVns3Topology", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "name": "vns3_topology_id", "in": "path", "description": "VNS3 Topology ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted VNS3 Topology 12" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing VNS3 Topology with ID 2" } } } } } } }, "/webhooks": { "get": { "description": "Return list of all configured webhooks", "summary": "Get webhooks", "operationId": "getWebhooks", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "validate_cert": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "body": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/webhook": { "post": { "description": "Create new webhook endpoint", "summary": "Create webhook", "operationId": "postCreateWebhook", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateWebhookRequest", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "Alert name", "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "body": { "description": "Payload for POST call", "type": "string" }, "validate_cert": { "type": "boolean", "default": false }, "custom_properties": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } } } }, "headers": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "parameters": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "nullable": true }, "validate_cert": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "body": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/webhook/{webhook_id}": { "get": { "description": "Retrieve details for single webhook integration", "summary": "Get webhook details", "operationId": "getWebhook", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "webhook_id", "description": "ID for webhook integration", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1webhook/post/responses/201/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested webhook does not exist" } } } } } }, "put": { "description": "Edit defined webhook integration", "summary": "Update webhook configuration", "operationId": "putUpdateWebhook", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "webhook_id", "description": "ID for webhook integration", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "UpdateWebhookRequest", "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "body": { "type": "string", "description": "Serialized HTTP Post request body" }, "validate_cert": { "type": "boolean" }, "custom_properties": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" } } } }, "headers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "parameters": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1webhook/post/responses/201/content/application~1json/schema" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested webhook does not exist" } } } } } }, "delete": { "description": "Delete defined webhook integration.", "summary": "Delete webhook", "operationId": "deleteWebhook", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "webhook_id", "description": "ID for webhook integration", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1webhook/post/responses/201/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested webhook does not exist" } } } } } } }, "/alerts": { "get": { "description": "Get list of all topology alerts", "summary": "Get alerts", "operationId": "getAlerts", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "webhook_id": { "type": "integer" }, "template_id": { "type": "integer" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/alert": { "post": { "description": "Create new network alert", "summary": "Create alert", "operationId": "postCreateAlert", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateAlertRequest", "type": "object", "oneOf": [ { "required": [ "name", "url", "webhook_id" ] }, { "required": [ "name", "url", "template_id" ] } ], "properties": { "name": { "description": "Alert name", "type": "string" }, "url": { "type": "string" }, "enabled": { "default": true, "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "custom_properties": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "webhook_id": { "type": "integer" }, "template_id": { "type": "integer" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string" }, "enabled": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } }, "custom_properties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "webhook_id": { "type": "integer" }, "template_id": { "type": "integer" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "webhook_id does not have a valid value" } } } } } } }, "/alert/{alert_id}": { "get": { "description": "Retrieve details for single alert definition", "summary": "Get alert details", "operationId": "getAlertDetails", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "alert_id", "description": "ID for Alert definition", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1alert/post/responses/201/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested alert does not exist" } } } } } }, "put": { "description": "Edit defined alert", "summary": "Edit alert definition", "operationId": "putUpdateAlert", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "alert_id", "description": "ID for Alert definition", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "title": "UpdateAlertRequest", "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "webhook_id": { "type": "integer" }, "events": { "type": "array", "items": { "type": "string" } }, "custom_properties": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "enabled": { "type": "boolean", "default": true } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1alert/post/responses/201/content/application~1json/schema" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested alert does not exist" } } } } } }, "delete": { "description": "Delete defined alert", "summary": "Delete alert", "operationId": "deleteAlert", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "alert_id", "description": "ID for Alert definition", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1alert/post/responses/201/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested alert does not exist" } } } } } } }, "/alert/{alert_id}/test": { "post": { "description": "Send test alert for this defined alert to configured webhook endpoint\n", "summary": "Send test alert", "operationId": "postTestAlert", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "alert_id", "description": "ID for Alert definition", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Alert sent successfully." } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested alert does not exist" } } } } } } }, "/alert/{alert_id}/toggle_enabled": { "post": { "description": "Enable this alert. Associated events will trigger alerts sent to configured webhook.\n", "summary": "Enable alert", "operationId": "postToggleEnableAlert", "x-sdk-module": "cloud_monitoring", "tags": [ "Cloud Monitoring" ], "parameters": [ { "in": "path", "name": "alert_id", "description": "ID for Alert definition", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1alert/post/responses/201/content/application~1json/schema" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Requested alert does not exist" } } } } } } }, "/snapshots": { "get": { "description": "Return a list of available snapshot files grouped by VNS3 controller (optionally filtered by VNS3 controller)\n", "summary": "Get VNS3 Snapshots", "operationId": "getVns3Snapshots", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "query", "description": "VNS3 controller ID", "schema": { "type": "integer" } }, { "name": "vns3_topology_id", "in": "query", "description": "VNS3:ms Topology ID", "schema": { "type": "integer" } }, { "name": "snapshot_id", "in": "query", "description": "Snapshot ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "snapshots": { "description": "Available snapshots", "type": "array", "items": { "type": "object", "properties": { "snapshot_id": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "snapshot_name": { "type": "string" }, "snapshot_size": { "type": "integer" }, "sha1_checksum": { "type": "string" }, "available": { "type": "boolean" }, "status": { "type": "string" }, "vns3_controller_id": { "type": "integer" }, "vns3_controller_name": { "type": "string" } } } }, "failed_snapshots": { "description": "Failed snapshots", "type": "array", "items": { "$ref": "#/paths/~1snapshots/get/responses/200/content/application~1json/schema/properties/response/properties/snapshots/items" } } } } } }, "example": { "response": { "failed_snapshots": [], "snapshots": [ { "snapshot_id": 1, "created_at": "2020-05-15T17:42:41.000Z", "snapshot_name": "snapshot_20200515_1589564561_52.72.51.23", "snapshot_size": 2072122, "sha1_checksum": "c9cbcaca7d0e1996ae2411fde50f74881eeac542", "available": true, "status": "Stored locally", "vns3_controller_id": 1, "vns3_controller_name": "test-vns3-bp" } ] } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing Snapshot with ID 7" } } } } } }, "post": { "description": "Create a snapshot for a particular VNS3 Controller", "summary": "Create VNS3 Snapshot", "operationId": "postCreateVns3Snapshot", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateVns3SnapshotRequest", "type": "object", "required": [ "vns3_controller_id" ], "properties": { "vns3_controller_id": { "description": "ID for VNS3 controller", "type": "integer" } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Snapshot created" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing VNS3 Controller with ID 9" } } } } } }, "delete": { "description": "Delete one or more snapshot files", "summary": "Delete VNS3 Snapshots", "operationId": "deleteVns3Snapshots", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "requestBody": { "content": { "application/json": { "schema": { "title": "deleteVns3SnapshotsRequest", "type": "object", "required": [ "snapshot_ids" ], "properties": { "snapshot_ids": { "description": "List of snapshot ids to delete", "type": "array", "items": { "type": "integer" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Accessible snapshots deleted" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/snapshots/download": { "get": { "description": "Download a specific snapshot file", "summary": "Download VNS3 snapshot", "operationId": "getDownloadVns3Snapshot", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "snapshot_id", "in": "query", "description": "Snapshot ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/plain": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing snapshot file" } } } } } } }, "/system/remote_support": { "get": { "description": "Is remote support enabled/disabled?", "summary": "Get Remote Support", "operationId": "getRemoteSupportDetails", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "remote_support_enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "remote_support_enabled": false } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "put": { "description": "Enable/Disable remote support", "summary": "Enable remote support", "operationId": "putRemoteSupport", "x-sdk-module": "system", "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "title": "putRemoteSupportRequest", "type": "object", "required": [ "enable" ], "properties": { "enable": { "description": "Enable/Disable remote support", "type": "boolean" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1system~1remote_support/get/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "remote_support_enabled": false } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/remote_support/keypair": { "get": { "description": "Check if remote support keypair is installed", "summary": "Get Remote Support Keypair", "operationId": "getRemoteSupportKeypairDetails", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "keypair_installed": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "keypair_installed": true } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Regenerate support keypair", "summary": "Regenerate support keypair", "operationId": "postGenerateRemoteSupportKeypair", "x-sdk-module": "system", "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postGenerateRemoteSupportKeypairRequest", "type": "object", "required": [ "encrypted_passphrase" ], "properties": { "encrypted_passphrase": { "description": "Encrypted passphrase provided by Cohesive Networks used to generate keypair\n", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "keypair_installed": { "type": "boolean" }, "private_key": { "type": "string" } } } } }, "example": { "response_type": "success", "response": { "keypair_installed": true, "private_key": "-----BEGIN RSA PRIVATE KEY-----..." } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Invalid passphrase" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "delete": { "description": "Delete support keypair, revoking access", "summary": "Delete support keypair", "operationId": "deleteRemoteSupportKeypair", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1system~1remote_support~1keypair/get/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "keypair_installed": false } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/status": { "get": { "description": "Get system status", "summary": "Get system status", "operationId": "getSystemStatus", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "system_disk": { "type": "object", "additionalProperties": true }, "data_disk": { "type": "object", "additionalProperties": true }, "cpus": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "load_average": { "type": "object", "additionalProperties": true }, "memory": { "type": "object", "additionalProperties": true }, "boot_time": { "type": "string", "format": "date-time" }, "system_time": { "type": "string", "format": "date-time" }, "uptime": { "type": "number" }, "virtual_networks": { "type": "integer" }, "vns3_topologies": { "type": "integer" }, "vns3_controllers": { "type": "integer" }, "cloud_vlans": { "type": "integer" }, "cloud_vlan_components": { "type": "integer" }, "ha_snapshot_file_count": { "type": "integer" }, "configuration_snapshot_file_count": { "type": "integer" }, "configuration_snapshot_failed_count": { "type": "integer" }, "system_backup_file_count": { "type": "integer" }, "system_snapshots_backup_file_count": { "type": "integer" } } } } }, "example": { "response_type": "success", "response": { "system_disk": { "type": null, "block_size": 4096, "free_blocks": 6026619, "available_blocks": 5633418, "total_blocks": 7707903 }, "data_disk": { "type": "ext4", "block_size": 4096, "free_blocks": 6026619, "available_blocks": 5633418, "total_blocks": 7707903 }, "cpus": [ { "num": 0, "user": 39504, "system": 23405, "nice": 1104, "idle": 16188202 }, { "num": 1, "user": 43161, "system": 25687, "nice": 1091, "idle": 16172235 } ], "load_average": { "one_minute": 0, "five_minutes": 0, "fifteen_minutes": 0 }, "memory": { "pagesize": 4096, "wired": 72275, "active": 299461, "inactive": 108891, "free": 21716, "pageins": 1443217, "pageouts": 6557828 }, "boot_time": "2020-05-13T19:52:48.004Z", "system_time": "2020-05-15T17:18:38.464Z", "uptime": 163550.459937419, "virtual_networks": 1, "vns3_topologies": 1, "vns3_controllers": 1, "cloud_vlans": 1, "cloud_vlan_components": 1, "ha_snapshot_file_count": 0, "configuration_snapshot_file_count": 0, "configuration_snapshot_failed_count": 0, "system_backup_file_count": 0, "system_snapshots_backup_file_count": 0 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/credential_types": { "get": { "description": "Get system credential types", "summary": "Get credential types", "operationId": "getCredentialTypes", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" }, "description": { "type": "string" } } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/credential_types/{code}": { "get": { "description": "Get credential type details", "summary": "Get credential type", "operationId": "getCredentialTypeDetails", "x-sdk-module": "system", "tags": [ "System" ], "parameters": [ { "name": "code", "in": "path", "description": "Credential type code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" }, "description": { "type": "string" } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Invalid credential type code xyz" } } } } } } }, "/system/ntp_hosts": { "get": { "description": "Get list of NTP hosts", "summary": "Get NTP hosts", "operationId": "getSystemNtpHosts", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "description": "Object of NTP hosts keyed by index in list", "additionalProperties": { "type": "string" } } } }, "example": { "response_type": "success", "response": { "0": "0.ubuntu.pool.ntp.org", "1": "1.ubuntu.pool.ntp.org", "2": "2.ubuntu.pool.ntp.org", "3": "3.ubuntu.pool.ntp.org", "4": "ntp.ubuntu.com" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Add host to NTP list", "summary": "Add new NTP host", "operationId": "postAddNtpHost", "x-sdk-module": "system", "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postAddNtpHostRequest", "type": "object", "required": [ "host" ], "properties": { "host": { "description": "New NTP hostname", "type": "string" } } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1system~1ntp_hosts/get/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "5": "ntp.ubuntu.com" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/ntp_hosts/{host_id}": { "delete": { "description": "Delete NTP host", "summary": "Delete NTP Host", "operationId": "deleteNtpHost", "x-sdk-module": "system", "tags": [ "System" ], "parameters": [ { "name": "host_id", "in": "path", "description": "NTP host index in list", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted NTP host ntp.host.com" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing NTP host with ID 6" } } } } } } }, "/system/ssl": { "delete": { "description": "Revoke and reset SSL cert and key pair", "summary": "Revoke SSL", "operationId": "deleteSslInstall", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "SSL Cert revocation queued", "uuid": "61246db30c51c3fe46779bcfc01eb6b3d2de" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/ssl/keypair": { "put": { "description": "Upload new SSL key/cert pair", "summary": "Upload SSL certs", "operationId": "putUploadSslCerts", "x-sdk-module": "system", "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUploadSslCertsRequest", "type": "object", "required": [ "cert", "key" ], "properties": { "cert": { "description": "New SSL cert", "type": "string" }, "key": { "description": "New SSL key", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Valid key/cert files uploaded" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Invalid data" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/ssl/install": { "put": { "description": "Install new SSL key/cert pair", "summary": "Install SSL certs", "operationId": "putInstallSslCerts", "x-sdk-module": "system", "tags": [ "System" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "SSL Cert installation queued", "uuid": "61246db30c51c3fe46779bcfc01eb6b3d2de" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing key/cert files" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/ssl/install/{uuid}": { "get": { "description": "Get new key/cert pair installation status (DEPRECATED)", "summary": "Get SSL install status", "operationId": "getSslInstallStatus", "x-sdk-module": "system", "tags": [ "System" ], "parameters": [ { "name": "uuid", "in": "path", "description": "Job UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "finished", "uuid": "abcasoidjf0q92039fnq039r" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Unknown job UUID: abcasoidjf0q92039fnq039r" } } } } } } }, "/system/controller_report": { "get": { "description": "Get controller report", "summary": "Get controller report", "operationId": "getControllerReport", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "report_date", "in": "query", "description": "Date of report", "schema": { "type": "string", "format": "date-time", "description": "iso8601 datetime" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "snapshot_date": { "type": "string", "format": "date-time" }, "snapshot": { "type": "array", "items": { "type": "object", "properties": { "controller_id": { "type": "integer" }, "controller_name": { "type": "string" }, "controller_version": { "type": "string" }, "active": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "topology_id": { "type": "integer" }, "topology_name": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "virtual_network_name": { "type": "string" }, "ha_backup_enabled": { "type": "boolean" } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/system/jobs/{uuid}": { "get": { "description": "Get system job status", "summary": "Get job status", "operationId": "getJobStatus", "x-sdk-module": "system", "tags": [ "System" ], "parameters": [ { "name": "uuid", "in": "path", "description": "Job UUID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups~1create_backup/post/responses/202/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "finished", "uuid": "abd37534c7d9a2efb9465de931" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Unknown job UUID: abd37534c7d9a2efb9465de931" } } } } } } }, "/user/password": { "put": { "description": "Update current user password", "summary": "Update user password", "operationId": "putUserPassword", "x-sdk-module": "users", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "title": "putRemoteSupportRequest", "type": "object", "required": [ "password" ], "properties": { "password": { "description": "New user password", "type": "string" }, "force_refresh": { "description": "Force session refresh", "type": "boolean" } } } } } }, "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Password updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/user/credentials": { "get": { "description": "Get user credentials", "summary": "Get user credentials", "operationId": "getUserCredentials", "x-sdk-module": "users", "tags": [ "Users" ], "parameters": [ { "name": "cred_id", "in": "query", "description": "Credential ID to filter by", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Return credential field values", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "string" }, "verified": { "type": "boolean" }, "verification_message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Create user credential", "summary": "Create user credential", "operationId": "postCreateUserCredential", "x-sdk-module": "users", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postCreateUserCredentialRequest", "type": "object", "required": [ "name", "code", "fields" ], "properties": { "name": { "description": "Credential name", "type": "string" }, "code": { "description": "Credential type code", "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "message": { "type": "string" }, "id": { "type": "integer" } } } } }, "example": { "response_type": "success", "response": { "message": "User credentials saved. Validating.", "id": 10 } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing required field code" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/user/credentials/{credential_id}": { "put": { "description": "Update user credential", "summary": "Update user credential", "operationId": "putUpdateUserCredential", "x-sdk-module": "users", "tags": [ "Users" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "Credential Id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateUserCredentialRequest", "type": "object", "properties": { "name": { "description": "Credential name", "type": "string" }, "code": { "description": "Credential type code", "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1user~1credentials/post/responses/201/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "message": "User credentials saved. Validating.", "id": 10 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "User Credential ID 10 does not exist" } } } } } }, "delete": { "description": "Delete user credential", "summary": "Delete user credential", "operationId": "deleteUserCredential", "x-sdk-module": "users", "tags": [ "Users" ], "parameters": [ { "name": "credential_id", "in": "path", "description": "Credential Id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Credentials deleted" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "Missing or undefined credentials." } } } } } } }, "/vns3_controllers": { "get": { "description": "Return list of all (accessible) VNS3 Controllers", "summary": "Get VNS3 Controllers", "operationId": "getVns3Controllers", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "query", "description": "Filter by VNS3 controller", "schema": { "type": "integer" } }, { "name": "vns3_topology_id", "in": "query", "description": "Filter by topology", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "owner": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "virtual_network": { "type": "string" }, "vns3_topology_id": { "type": "integer" }, "vns3_topology": { "type": "string" }, "vns3_address": { "type": "string" }, "private_ip_address": { "nullable": true, "type": "string" }, "vns3_version": { "type": "string" }, "licensed": { "nullable": true, "type": "boolean" }, "active": { "type": "boolean" }, "peered": { "nullable": true, "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "alerts_enabled": { "type": "boolean" }, "controller_status": { "type": "object", "properties": { "last_contact_time": { "type": "string", "format": "date-time" }, "last_successful_contact_time": { "type": "string", "format": "date-time" }, "last_contact_code": { "type": "integer" }, "last_contact_result": { "type": "string" }, "failed_contact_count": { "type": "integer" }, "alerts_enabled": { "type": "boolean" } } } } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } }, "post": { "description": "Add VNS3 Controller to a VNS3 topology for management", "summary": "Add VNS3 Controller", "operationId": "postAddVns3Controller", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "requestBody": { "content": { "application/json": { "schema": { "title": "postAddVns3ControllerRequest", "type": "object", "required": [ "name", "vns3_topology_id", "address" ], "properties": { "name": { "description": "VNS3 Controller name", "type": "string" }, "vns3_topology_id": { "description": "Parent VNS3 Topology ID", "type": "integer" }, "address": { "description": "VNS3 Controller IP address", "type": "string" }, "active": { "description": "Active state", "type": "boolean" }, "api_v1_key": { "description": "Controller's APIv1 key", "type": "string" }, "description": { "description": "Controller description", "type": "string" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/paths/~1cloud_vlan_components/post/responses/201/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "msg": "VNS3 Controller created", "id": 17 } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" } } } }, "/vns3_controllers/{vns3_controller_id}": { "get": { "description": "Return specific VNS3 Controller details", "summary": "Get VNS3 Controller", "operationId": "getVns3Controller", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "owner": { "type": "string" }, "virtual_network_id": { "type": "integer" }, "virtual_network": { "type": "string" }, "vns3_topology_id": { "type": "integer" }, "vns3_topology": { "type": "string" }, "vns3_address": { "type": "string" }, "private_ip_address": { "nullable": true, "type": "string" }, "vns3_version": { "type": "string" }, "licensed": { "nullable": true, "type": "boolean" }, "active": { "type": "boolean" }, "peered": { "nullable": true, "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "alerts_enabled": { "type": "boolean" }, "controller_status": { "type": "object", "properties": { "last_contact_time": { "type": "string", "format": "date-time" }, "last_successful_contact_time": { "type": "string", "format": "date-time" }, "last_contact_code": { "type": "integer" }, "last_contact_result": { "type": "string" }, "failed_contact_count": { "type": "integer" }, "alerts_enabled": { "type": "boolean" } } } } } } }, "example": { "response": { "id": 1, "name": "test-vns3-bp", "owner": "admin", "virtual_network_id": 1, "virtual_network": "dev-env-network", "vns3_topology_id": 1, "vns3_topology": "Test VNS3 Topology", "vns3_address": "10.0.1.34", "private_ip_address": null, "vns3_version": "3.5-default", "licensed": true, "active": true, "peered": null, "description": null, "alerts_enabled": false, "controller_status": { "last_contact_time": "2020-05-15T17:47:25.000Z", "last_successful_contact_time": "2020-05-15T17:47:25.000Z", "last_contact_code": 200, "last_contact_result": "OK", "failed_contact_count": 0, "alerts_enabled": false } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } }, "put": { "description": "Update specified VNS3 Controller", "summary": "Update VNS3 Controller", "operationId": "putUpdateVns3Controller", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateVns3ControllerRequest", "type": "object", "properties": { "name": { "description": "VNS3 Controller name", "type": "string" }, "vns3_topology_id": { "description": "Parent VNS3 Topology ID", "type": "integer" }, "address": { "description": "VNS3 Controller IP address", "type": "string" }, "active": { "description": "Active state", "type": "boolean" }, "api_v1_key": { "description": "Controller's APIv1 key", "type": "string" }, "description": { "description": "Controller description", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Updated VNS3 controller" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } }, "delete": { "description": "Delete VNS3 Controller", "summary": "Delete VNS3 Controller", "operationId": "deleteVns3Controller", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "Deleted VNS3 Controller 12" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/status": { "get": { "description": "Retrieve the status and live details of the selected controller", "summary": "Get Controller Status", "operationId": "getVns3ControllerStatus", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "manager_accessible": { "type": "boolean" }, "controller_status": { "type": "object", "additionalProperties": true, "properties": { "last_contact_time": { "type": "string", "format": "date-time" }, "last_successful_contact_time": { "type": "string", "format": "date-time" }, "last_contact_code": { "type": "integer" }, "last_contact_result": { "type": "string" }, "failed_contact_count": { "type": "integer" }, "alerts_enabled": { "type": "boolean", "nullable": true } } }, "status": { "type": "object", "additionalProperties": true, "properties": { "system_config": { "type": "object", "additionalProperties": true, "properties": { "topology_checksum": { "type": "string" }, "vns3_version": { "type": "string" }, "topology_name": { "type": "string" }, "ntp_hosts": { "type": "string" }, "licensed": { "type": "boolean", "nullable": true }, "peered": { "type": "boolean" }, "private_ip": { "type": "string" }, "public_ip": { "type": "string" } } }, "system_status": { "type": "object", "additionalProperties": true, "properties": { "mem_info": { "type": "object", "properties": { "mem_total": { "type": "number" }, "mem_used": { "type": "number" }, "mem_free": { "type": "number" }, "shmem": { "type": "number" }, "buffers": { "type": "number" }, "cached": { "type": "number" }, "swap_total": { "type": "number" }, "swap_used": { "type": "number" }, "swap_free": { "type": "number" }, "swap_cached": { "type": "number" } } }, "disk_info": { "type": "array", "items": { "type": "object" } }, "system_info": { "type": "object", "additionalProperties": true }, "cpu_info": { "type": "object", "additionalProperties": true } } }, "connection_status": { "type": "string", "nullable": true }, "container_status": { "type": "object", "properties": { "running": { "type": "boolean" }, "network": { "type": "string" }, "image_limit": { "type": "integer" }, "images_stored": { "type": "integer" }, "container_limit": { "type": "integer" }, "containers_stored": { "type": "integer", "nullable": true }, "containers_running": { "type": "integer" } } }, "peering_details": { "type": "object", "additionalProperties": true, "properties": { "peered": { "type": "boolean" } } }, "cloud_details": { "type": "object", "additionalProperties": true } } } } } } }, "example": { "response_type": "success", "response": { "manager_accessible": true, "controller_status": { "last_contact_time": "2020-05-15T18:00:27.472Z", "last_successful_contact_time": "2020-05-15T18:00:27.472Z", "last_contact_code": 200, "last_contact_result": "OK", "failed_contact_count": 0, "alerts_enabled": null }, "status": { "system_config": { "topology_checksum": "c95ae5b12c54f3f14d232dbb4fa3aa718953ebf5", "vns3_version": "4.9.2-20200325", "topology_name": "test", "ntp_hosts": "0.ubuntu.pool.ntp.org 1.ubuntu.pool.ntp.org 2.ubuntu.pool.ntp.org\n3.ubuntu.pool.ntp.org ntp.ubuntu.com time.apple.com", "licensed": true, "peered": false, "private_ip": "10.0.1.34", "public_ip": "52.72.51.23" }, "system_status": { "mem_info": { "mem_total": 2009276, "mem_used": 1914080, "mem_free": 95196, "shmem": 44908, "buffers": 134804, "cached": 1251788, "swap_total": 1048572, "swap_used": 0, "swap_free": 1048572, "swap_cached": 0 }, "disk_info": [ { "filesystem": "/dev/nvme0n1p1", "type": "", "bytes_total": "31571570688", "bytes_used": "4348542976", "bytes_available": "25612476416", "percent_used": "15%", "mount_point": "/" } ], "system_info": { "uptime": 161568, "clean_uptime": { "days": 1, "hours": 20, "minutes": 52, "seconds": 48 }, "kernel": "4.4.0-154-generic", "loadavg": { "current": "0.03", "last_5min": "0.04", "last_15min": "0.00", "threads": "1/245", "last_pid": "32767" } }, "cpu_info": {} }, "connection_status": null, "container_status": { "running": true, "network": "198.51.100.0/28", "image_limit": 50, "images_stored": 0, "container_limit": 4, "containers_stored": null, "containers_running": 0 }, "peering_details": { "peered": false }, "cloud_details": { "cloud_type": "ec2", "cloud_data": { "accountId": "947761958079", "architecture": "x86_64", "availabilityZone": "us-east-1a", "billingProducts": null, "devpayProductCodes": null, "marketplaceProductCodes": null, "imageId": "ami-075660543a425327f", "instanceId": "i-05aea17762c173034", "instanceType": "t3.small", "kernelId": null, "pendingTime": "2020-05-13T19:52:15.000Z", "privateIp": "10.0.1.34", "ramdiskId": null, "region": "us-east-1", "version": "2017-09-30T00:00:00.000Z" } } } } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/update_api_password": { "put": { "description": "Update specified VNS3 Controller API password", "summary": "Update Controller API Password", "operationId": "putVns3ControllerApiPassword", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putVns3ControllerApiPasswordRequest", "type": "object", "required": [ "api_password" ], "properties": { "api_password": { "description": "New API password", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "API password updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/update_ui": { "put": { "description": "Update specified VNS3 Controller UI", "summary": "Update Controller UI", "operationId": "putVns3ControllerUi", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putVns3ControllerUiRequest", "type": "object", "properties": { "username": { "description": "UI username", "type": "string" }, "password": { "description": "VNS3 Controller GUI password", "type": "string" }, "ui_enabled": { "description": "Enable/Disable UI", "type": "boolean" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "UI details updated" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/ha": { "get": { "description": "Get HA details for specified VNS3 controller", "summary": "Get Controller HA details", "operationId": "getVns3ControllerHaDetails", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "ha_enabled": { "type": "boolean" }, "ha_initialised": { "type": "boolean" }, "ha_cloud_validated": { "type": "boolean" }, "ha_uuid": { "type": "string" }, "ha_backup_ip_address": { "type": "string" }, "primary_sync_state": { "type": "string" }, "primary_sync_code": { "type": "string" }, "ms_sync_state": { "type": "string" }, "ms_sync_fail_count": { "type": "integer" }, "backup_active": { "type": "boolean" }, "backup_sync_state": { "type": "string" }, "backup_sync_code": { "type": "string" }, "backup_sync_fail_count": { "type": "integer" }, "activation_state": { "type": "string" }, "ha_cloud_cred_id": { "type": "integer" }, "primary_server_available": { "type": "boolean" }, "backup_server_available": { "type": "boolean" }, "ha_type": { "type": "string" }, "ha_sync_processing": { "type": "boolean" }, "ha_api_v2_username": { "type": "string" }, "stop_old_primary": { "type": "boolean" }, "ha_instance_id": { "type": "string" }, "ha_image_id": { "type": "string" }, "primary_sync_updated_at": { "type": "string", "format": "date-time" }, "ms_sync_updated_at": { "type": "string", "format": "date-time" }, "backup_sync_updated_at": { "type": "string", "format": "date-time" } } } } }, "example": { "response_type": "success", "response": { "ha_enabled": true, "ha_initialised": false, "ha_cloud_validated": true, "ms_sync_state": "Available", "ms_sync_fail_count": 0, "backup_active": false, "backup_sync_fail_count": 0, "ha_cloud_cred_id": 0, "primary_server_available": true, "backup_server_available": false, "ha_type": "cold", "ha_sync_processing": false, "ha_instance_id": "", "ha_image_id": "ami-abcdefgh" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } }, "put": { "description": "Update HA details for specified VNS3 controller", "summary": "Update VNS3 Controller HA", "operationId": "putUpdateVns3ControllerHa", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putUpdateVns3ControllerHaRequest", "type": "object", "oneOf": [ { "required": [ "ha_enabled" ] }, { "required": [ "ha_enabled", "ha_uuid", "ha_backup_ip_address" ] }, { "required": [ "ha_enabled", "ha_instance_id" ] }, { "required": [ "ha_enabled", "ha_image_id" ] } ], "required": [ "ha_enabled" ], "properties": { "ha_enabled": { "description": "Enable/Disable HA", "type": "string" }, "ha_type": { "description": "HA type, can be hot, warm or cold", "type": "integer" }, "ha_uuid": { "description": "HA UUID of the VNS3 failover box for hot HA. Required for hot HA.", "type": "string" }, "ha_backup_ip_address": { "description": "HA Backup server IP address. Required for hot HA.", "type": "string" }, "ha_api_v1_key": { "description": "Controller's APIv1 key", "type": "string" }, "ha_instance_id": { "description": "VNS3 standby instance for warm HA. Required for warm HA.", "type": "string" }, "ha_image_id": { "description": "VNS3 image ID for Cold HA. Required for cold HA.", "type": "string" }, "ha_cloud_cred_id": { "description": "Cloud Credential ID", "type": "integer" }, "stop_old_primary": { "description": "Shutdown old primary on activation", "type": "boolean" }, "ha_instance_type": { "description": "Instance type to use when launching new controller for cold HA", "type": "string" }, "ha_availability_zone": { "description": "AZ to use when launching new controller for cold HA", "type": "string" }, "ha_subnet": { "description": "Subnet to use when launching new controller for cold HA", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "msg": { "type": "string" }, "ha_enabled": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "msg": "HA details updated", "ha_enabled": true } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/ha/validate": { "put": { "description": "Validate HA details", "summary": "Validate Controller HA details", "operationId": "putValidateVns3ControllerHa", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "msg": { "type": "string" }, "ha_enabled": { "type": "boolean" }, "ha_cloud_validated": { "type": "boolean" } } } } }, "example": { "response_type": "success", "response": { "msg": "HHA not enabled; details not validated", "ha_enabled": false, "ha_cloud_validated": true } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/ha/initialise": { "put": { "description": "Initialise HA for specified VNS3 controller and its backup device,\nset up pairing and configuration", "summary": "Initialise Controller HA", "operationId": "putInitVns3ControllerHa", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "HA configuration initialised" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/ha/sync": { "put": { "description": "Trigger HA sync (via the queueing mechanism)", "summary": "Trigger HA sync", "operationId": "putSyncVns3ControllerHa", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "title": "putSyncVns3ControllerHaRequest", "type": "object", "required": [ "sync_type" ], "properties": { "sync_type": { "description": "Type of sync to perform: full, pull or push", "type": "string" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1auth~1api_key~1%7Bkey_id%7D/delete/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": "HA sync request queued" } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } }, "/vns3_controllers/{vns3_controller_id}/ha/activate": { "get": { "description": "Get current status of HA switchover activation", "summary": "Get HA status", "operationId": "getVns3ControllerHaStatus", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response_type": { "type": "string" }, "response": { "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "log_msgs": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "status_message": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } } } } } } } }, "example": { "response_type": "success", "response": { "status": "Running", "timestamp": "2020-05-06T16:06:56.510Z", "log_msgs": [ { "status": "success", "status_message": "Activating", "timestamp": "2020-05-06T16:06:56.510Z" } ] } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } }, "put": { "description": "Trigger the HA switchover activation", "summary": "Trigger HA", "operationId": "putActivateVns3ControllerHa", "x-sdk-module": "vns3_management", "tags": [ "VNS3 Management" ], "parameters": [ { "name": "vns3_controller_id", "in": "path", "description": "VNS3 Controller ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/paths/~1vns3_controllers~1%7Bvns3_controller_id%7D~1ha~1activate/get/responses/200/content/application~1json/schema" }, "example": { "response_type": "success", "response": { "status": "Running", "message": "HA activation request queued", "timestamp": "2020-05-06T16:06:56.510Z", "log_msgs": [ { "status": "success", "status_message": "Activating", "timestamp": "2020-05-06T16:06:56.510Z" } ] } } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/paths/~1vns3_controllers~1%7Bvns3_controller_id%7D~1ha~1activate/get/responses/200/content/application~1json/schema" }, "example": { "response_type": "error", "response": { "status": "Failed", "message": "Unable to activate: Failed to launch instance", "timestamp": "2020-05-06T16:06:56.510Z" } } } } }, "401": { "$ref": "#/paths/~1auth/post/responses/401" }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/paths/~1backups/delete/responses/404/content/application~1json/schema" }, "example": { "response_type": "error", "response": "VNS3 Controller with ID 19 does not exist" } } } } } } } }, "components": { "securitySchemes": { "ApiTokenAuth": { "type": "apiKey", "in": "header", "name": "api-token", "description": "Temporary token authentication. Expiring tokens are generated with the POST /auth endpoint, passing an active API key.\n" } } } }