{ "id": "@itentialopensource/adapter-openstack_neutron", "type": "Adapter", "export": "OpenstackNeutron", "title": "Openstack_neutron", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "listAPIVersions", "summary": "List API versions", "description": "List API versions", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listAPIVersions" }, "task": true }, { "name": "showAPIV2Details", "summary": "Show API v2 details", "description": "Show API v2 details", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/showAPIV2Details" }, "task": true }, { "name": "listExtensions", "summary": "List extensions", "description": "List extensions", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listExtensions" }, "task": true }, { "name": "showExtensionDetails", "summary": "Show extension details", "description": "Show extension details", "input": [ { "name": "alias", "type": "string", "info": "The alias of an extension.: string", "required": true, "schema": { "title": "alias", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showExtensionDetails" }, "task": true }, { "name": "showNetworkDetails", "summary": "Show network details", "description": "Show network details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "networkId", "type": "string", "info": "The ID of the network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworkDetails" }, "task": true }, { "name": "updateNetwork", "summary": "Update network", "description": "Update network", "input": [ { "name": "networkId", "type": "string", "info": "The ID of the network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"network\": {\"dns_domain\": \"string\", \"name\": \"string\", \"qos_policy_id\": \"string\", \"mtu\": 123}}", "required": false, "schema": { "type": "object", "properties": { "network": { "type": "object", "properties": { "dns_domain": { "type": "string" }, "name": { "type": "string" }, "qos_policy_id": { "type": "string" }, "mtu": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateNetwork" }, "task": true }, { "name": "deleteNetwork", "summary": "Delete network", "description": "Delete network", "input": [ { "name": "networkId", "type": "string", "info": "The ID of the network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetwork" }, "task": true }, { "name": "listNetworks", "summary": "List networks", "description": "List networks", "input": [ { "name": "adminStateUp", "type": "boolean", "info": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).: boolean", "required": false, "schema": { "title": "adminStateUp", "type": "boolean" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "mtu", "type": "number", "info": "Filter the network list result by the maximum transmission unit (MTU)\nvalue to address fragmentation. Minimum value is 68 for IPv4,\nand 1280 for IPv6.: 123", "required": false, "schema": { "title": "mtu", "type": "number" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "providerNetworkType", "type": "string", "info": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking...(description truncated): string", "required": false, "schema": { "title": "providerNetworkType", "type": "string" } }, { "name": "providerPhysicalNetwork", "type": "string", "info": "Filter the list result by the physical network where\nthis network/segment is implemented.: string", "required": false, "schema": { "title": "providerPhysicalNetwork", "type": "string" } }, { "name": "providerSegmentationId", "type": "number", "info": "Filter the list result by the ID of the isolated segment\non the physical network.: 123", "required": false, "schema": { "title": "providerSegmentationId", "type": "number" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "routerExternal", "type": "boolean", "info": "Filter the network list result based on whether the network has an\nexternal routing facility that’s not managed by the networking service.: boolean", "required": false, "schema": { "title": "routerExternal", "type": "boolean" } }, { "name": "shared", "type": "boolean", "info": "Filter the network list result based on if the network is shared across\nall tenants.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "status", "type": "string", "info": "Filter the network list result by network status. Values are ACTIVE,\nDOWN, BUILD or ERROR.: string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "vlanTransparent", "type": "boolean", "info": "Filter the network list by the VLAN transparency mode of the network,\nwhich is VLAN transparent (true) or not VLAN transparent (false).: boolean", "required": false, "schema": { "title": "vlanTransparent", "type": "boolean" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "isDefault", "type": "boolean", "info": "Filter the network list result based on if the network is default pool\nor not.: boolean", "required": false, "schema": { "title": "isDefault", "type": "boolean" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a network attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNetworks" }, "task": true }, { "name": "createNetwork", "summary": "Create network", "description": "Create network", "input": [ { "name": "body", "type": "object", "info": ": {\"network\": {\"admin_state_up\": \"boolean\", \"name\": \"string\", \"provider:network_type\": \"string\", \"provider:physical_network\": \"string\", \"provider:segmentation_id\": 123, \"qos_policy_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "network": { "type": "object", "properties": { "admin_state_up": { "type": "boolean" }, "name": { "type": "string" }, "provider:network_type": { "type": "string" }, "provider:physical_network": { "type": "string" }, "provider:segmentation_id": { "type": "integer" }, "qos_policy_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetwork" }, "task": true }, { "name": "showNetworkSegmentRangeDetails", "summary": "Show network segment range details", "description": "Show network segment range details", "input": [ { "name": "networkSegmentRangeId", "type": "string", "info": "The ID of the network segment range.: string", "required": true, "schema": { "title": "networkSegmentRangeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworkSegmentRangeDetails" }, "task": true }, { "name": "updateNetworkSegmentRange", "summary": "Update network segment range", "description": "Update network segment range", "input": [ { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "networkSegmentRangeId", "type": "string", "info": "The ID of the network segment range.: string", "required": true, "schema": { "title": "networkSegmentRangeId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"network_segment_range\": {\"name\": \"string\", \"minimum\": 123, \"maximum\": 123, \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "network_segment_range": { "type": "object", "properties": { "name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateNetworkSegmentRange" }, "task": true }, { "name": "deleteNetworkSegmentRange", "summary": "Delete network segment range", "description": "Delete network segment range", "input": [ { "name": "networkSegmentRangeId", "type": "string", "info": "The ID of the network segment range.: string", "required": true, "schema": { "title": "networkSegmentRangeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkSegmentRange" }, "task": true }, { "name": "listNetworkSegmentRanges", "summary": "List network segment ranges", "description": "List network segment ranges", "input": [ { "name": "id", "type": "string", "info": "Filter the network segment range list result based on the range ID.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the network segment range list result based on the name of the\nrange.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "networkType", "type": "string", "info": "Filter the list result by the type of physical network that this\nnetwork segment range is mapped to. For example, vlan, vxlan, or\ngre. Valid values depend on a networking...(description truncated): string", "required": false, "schema": { "title": "networkType", "type": "string" } }, { "name": "physicalNetwork", "type": "string", "info": "Filter the list result by the physical network where this\nnetwork segment range is implemented.: string", "required": false, "schema": { "title": "physicalNetwork", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a network segment range attribute. You can specify multiple pairs\nof sort key and sort direction query parameters. The sort keys are limited\nto:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNetworkSegmentRanges" }, "task": true }, { "name": "createNetworkSegmentRange", "summary": "Create network segment range", "description": "Create network segment range", "input": [ { "name": "body", "type": "object", "info": ": {\"network_segment_range\": {\"name\": \"string\", \"description\": \"string\", \"shared\": \"boolean\", \"project_id\": \"string\", \"network_type\": \"string\", \"physical_network\": \"string\", \"minimum\": 123, \"maximum\": 123}}", "required": false, "schema": { "type": "object", "properties": { "network_segment_range": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shared": { "type": "boolean" }, "project_id": { "type": "string" }, "network_type": { "type": "string" }, "physical_network": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkSegmentRange" }, "task": true }, { "name": "showPortDetails", "summary": "Show port details", "description": "Show port details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "portId", "type": "string", "info": "The ID of the port.: string", "required": true, "schema": { "title": "portId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPortDetails" }, "task": true }, { "name": "updatePort", "summary": "Update port", "description": "Update port", "input": [ { "name": "portId", "type": "string", "info": "The ID of the port.: string", "required": true, "schema": { "title": "portId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port\": {\"binding:host_id\": \"string\", \"binding:profile\": \"object\", \"device_id\": \"string\", \"data_plane_status\": \"string\", \"device_owner\": \"string\", \"qos_policy_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "port": { "type": "object", "properties": { "binding:host_id": { "type": "string" }, "binding:profile": { "type": "object" }, "device_id": { "type": "string" }, "data_plane_status": { "type": "string" }, "device_owner": { "type": "string" }, "qos_policy_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePort" }, "task": true }, { "name": "deletePort", "summary": "Delete port", "description": "Delete port", "input": [ { "name": "portId", "type": "string", "info": "The ID of the port.: string", "required": true, "schema": { "title": "portId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePort" }, "task": true }, { "name": "listPorts", "summary": "List ports", "description": "List ports", "input": [ { "name": "adminStateUp", "type": "boolean", "info": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).: boolean", "required": false, "schema": { "title": "adminStateUp", "type": "boolean" } }, { "name": "bindingHostId", "type": "string", "info": "Filter the port list result by the ID of the host where the port resides.: string", "required": false, "schema": { "title": "bindingHostId", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "deviceId", "type": "string", "info": "Filter the port list result by the ID of the device that uses this port.\nFor example, a server instance or a logical router.: string", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "deviceOwner", "type": "string", "info": "Filter the port result list by the entity type that uses this port.\nFor example, compute:nova (server instance), network:dhcp\n(DHCP agent) or network:router_interface (ro...(description truncated): string", "required": false, "schema": { "title": "deviceOwner", "type": "string" } }, { "name": "fixedIps", "type": "string", "info": "Filter the port list result by the IP addresses for the port.\nThis field has one or multiple entries.\nEach entry consists of IP address (ip_address), IP address substring...(description truncated): string", "required": false, "schema": { "title": "fixedIps", "type": "string" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "ipAllocation", "type": "string", "info": "Filter the port list result based on if the ports use deferred,\nimmediate or no IP allocation (none).: string", "required": false, "schema": { "title": "ipAllocation", "type": "string" } }, { "name": "macAddress", "type": "string", "info": "Filter the port list result by the MAC address of the port.: string", "required": false, "schema": { "title": "macAddress", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "networkId", "type": "string", "info": "Filter the list result by the ID of the attached network.: string", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a port attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "status", "type": "string", "info": "Filter the port list result by the port status.\nValues are ACTIVE, DOWN, BUILD and ERROR.: string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "macLearningEnabled", "type": "boolean", "info": "Filter the list result by the mac_learning_enabled state of the resource,\nwhich is enabled (true) or disabled (false).: boolean", "required": false, "schema": { "title": "macLearningEnabled", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listPorts" }, "task": true }, { "name": "createPort", "summary": "Create port", "description": "Create port", "input": [ { "name": "body", "type": "object", "info": ": {\"port\": {\"binding:host_id\": \"string\", \"binding:profile\": {\"local_link_information\": [{\"port_id\": \"string\", \"switch_id\": \"string\", \"switch_info\": \"string\"}]}, \"binding:vnic_type\": \"string\", \"device_id\": \"string\", \"device_owner\": \"string\", \"dns_domain\": \"string\", \"dns_name\": \"string\", \"qos_policy_id\": \"string\", \"propagate_uplink_status\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "port": { "type": "object", "properties": { "binding:host_id": { "type": "string" }, "binding:profile": { "type": "object", "properties": { "local_link_information": { "type": "array", "items": { "type": "object", "properties": { "port_id": { "type": "string" }, "switch_id": { "type": "string" }, "switch_info": { "type": "string" } } } } } }, "binding:vnic_type": { "type": "string" }, "device_id": { "type": "string" }, "device_owner": { "type": "string" }, "dns_domain": { "type": "string" }, "dns_name": { "type": "string" }, "qos_policy_id": { "type": "string" }, "propagate_uplink_status": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPort" }, "task": true }, { "name": "showSegmentDetails", "summary": "Show segment details", "description": "Show segment details", "input": [ { "name": "segmentId", "type": "string", "info": "The UUID of the segment.: string", "required": true, "schema": { "title": "segmentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSegmentDetails" }, "task": true }, { "name": "updateSegment", "summary": "Update segment", "description": "Update segment", "input": [ { "name": "segmentId", "type": "string", "info": "The UUID of the segment.: string", "required": true, "schema": { "title": "segmentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"segment\": {\"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "segment": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSegment" }, "task": true }, { "name": "deleteSegment", "summary": "Delete segment", "description": "Delete segment", "input": [ { "name": "segmentId", "type": "string", "info": "The UUID of the segment.: string", "required": true, "schema": { "title": "segmentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSegment" }, "task": true }, { "name": "listSegments", "summary": "List segments", "description": "List segments", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "networkId", "type": "string", "info": "Filter the list result by the ID of the attached network.: string", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "physicalNetwork", "type": "string", "info": "Filter the list result by the physical network where\nthis network/segment is implemented.: string", "required": false, "schema": { "title": "physicalNetwork", "type": "string" } }, { "name": "networkType", "type": "string", "info": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking...(description truncated): string", "required": false, "schema": { "title": "networkType", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "segmentationId", "type": "number", "info": "Filter the list result by the ID of the isolated segment\non the physical network.: 123", "required": false, "schema": { "title": "segmentationId", "type": "number" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a segment attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSegments" }, "task": true }, { "name": "createSegment", "summary": "Create segment", "description": "Create segment", "input": [ { "name": "body", "type": "object", "info": ": {\"segment\": {\"network_id\": \"string\", \"segmentation_id\": 123, \"network_type\": \"string\", \"physical_network\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "segment": { "type": "object", "properties": { "network_id": { "type": "string" }, "segmentation_id": { "type": "integer" }, "network_type": { "type": "string" }, "physical_network": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSegment" }, "task": true }, { "name": "listTrunks", "summary": "List trunks", "description": "List trunks", "input": [ { "name": "adminStateUp", "type": "boolean", "info": "Filter the trunk list result by the administrative state of the trunk,\nwhich is up (true) or down (false).: boolean", "required": false, "schema": { "title": "adminStateUp", "type": "boolean" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "portId", "type": "string", "info": "Filter the trunk list result by the ID of the parent port.: string", "required": false, "schema": { "title": "portId", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "status", "type": "string", "info": "Filter the trunk list result by the status for the trunk. Possible values\nare ACTIVE, DOWN, BUILD, DEGRADED, and ERROR.: string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a trunk attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listTrunks" }, "task": true }, { "name": "createTrunk", "summary": "Create trunk", "description": "Create trunk", "input": [ { "name": "body", "type": "object", "info": ": {\"trunk\": {\"port_id\": \"string\", \"name\": \"string\", \"admin_state_up\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "trunk": { "type": "object", "properties": { "port_id": { "type": "string" }, "name": { "type": "string" }, "admin_state_up": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTrunk" }, "task": true }, { "name": "addSubportsToTrunk", "summary": "Add subports to trunk", "description": "Add subports to trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"sub_ports\": [{\"segmentation_id\": 123, \"port_id\": \"string\", \"segmentation_type\": \"string\"}]}", "required": false, "schema": { "type": "object", "properties": { "sub_ports": { "type": "array", "items": { "type": "object", "properties": { "segmentation_id": { "type": "integer" }, "port_id": { "type": "string" }, "segmentation_type": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSubportsToTrunk" }, "task": true }, { "name": "deleteSubportsFromTrunk", "summary": "Delete subports from trunk", "description": "Delete subports from trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"sub_ports\": [{\"port_id\": \"string\"}]}", "required": false, "schema": { "type": "object", "properties": { "sub_ports": { "type": "array", "items": { "type": "object", "properties": { "port_id": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubportsFromTrunk" }, "task": true }, { "name": "listSubportsForTrunk", "summary": "List subports for trunk", "description": "List subports for trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSubportsForTrunk" }, "task": true }, { "name": "updateTrunk", "summary": "Update trunk", "description": "Update trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"trunk\": {\"name\": \"string\", \"admin_state_up\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "trunk": { "type": "object", "properties": { "name": { "type": "string" }, "admin_state_up": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTrunk" }, "task": true }, { "name": "showTrunk", "summary": "Show trunk", "description": "Show trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTrunk" }, "task": true }, { "name": "deleteTrunk", "summary": "Delete trunk", "description": "Delete trunk", "input": [ { "name": "trunkId", "type": "string", "info": "The ID of the trunk.: string", "required": true, "schema": { "title": "trunkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTrunk" }, "task": true }, { "name": "showAddressScope", "summary": "Show address scope", "description": "Show address scope", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "addressScopeId", "type": "string", "info": "The ID of the address scope.: string", "required": true, "schema": { "title": "addressScopeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressScope" }, "task": true }, { "name": "updateAnAddressScope", "summary": "Update an address scope", "description": "Update an address scope", "input": [ { "name": "addressScopeId", "type": "string", "info": "The ID of the address scope.: string", "required": true, "schema": { "title": "addressScopeId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address_scope\": {\"name\": \"string\", \"shared\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "address_scope": { "type": "object", "properties": { "name": { "type": "string" }, "shared": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAnAddressScope" }, "task": true }, { "name": "deleteAnAddressScope", "summary": "Delete an address scope", "description": "Delete an address scope", "input": [ { "name": "addressScopeId", "type": "string", "info": "The ID of the address scope.: string", "required": true, "schema": { "title": "addressScopeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAnAddressScope" }, "task": true }, { "name": "listAddressScopes", "summary": "List address scopes", "description": "List address scopes", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "ipVersion", "type": "number", "info": "Filter the list result by the IP protocol version.\nValid value is 4 or 6.: 123", "required": false, "schema": { "title": "ipVersion", "type": "number" } }, { "name": "shared", "type": "boolean", "info": "Admin-only. Filter the list result based on whether the resource is\nshared across all projects.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "sortKey", "type": "string", "info": "Sorts by an address scope attribute. You can specify multiple pairs of sort\nkey and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAddressScopes" }, "task": true }, { "name": "createAddressScope", "summary": "Create address scope", "description": "Create address scope", "input": [ { "name": "body", "type": "object", "info": ": {\"address_scope\": {\"name\": \"string\", \"tenant_id\": \"string\", \"ip_version\": 123, \"shared\": \"boolean\", \"project_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "address_scope": { "type": "object", "properties": { "name": { "type": "string" }, "tenant_id": { "type": "string" }, "ip_version": { "type": "integer" }, "shared": { "type": "boolean" }, "project_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createAddressScope" }, "task": true }, { "name": "showConntrackHelper", "summary": "Show conntrack helper", "description": "Show conntrack helper", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "conntrackHelperId", "type": "string", "info": "The ID of the conntrack helper.: string", "required": true, "schema": { "title": "conntrackHelperId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showConntrackHelper" }, "task": true }, { "name": "updateAConntrackHelper", "summary": "Update a conntrack helper", "description": "Update a conntrack helper", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "conntrackHelperId", "type": "string", "info": "The ID of the conntrack helper.: string", "required": true, "schema": { "title": "conntrackHelperId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"conntrack_helper\": {\"helper\": \"string\", \"protocol\": \"string\", \"port\": 123}}", "required": false, "schema": { "type": "object", "properties": { "conntrack_helper": { "type": "object", "properties": { "helper": { "type": "string" }, "protocol": { "type": "string" }, "port": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAConntrackHelper" }, "task": true }, { "name": "deleteAConntrackHelper", "summary": "Delete a conntrack helper", "description": "Delete a conntrack helper", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "conntrackHelperId", "type": "string", "info": "The ID of the conntrack helper.: string", "required": true, "schema": { "title": "conntrackHelperId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAConntrackHelper" }, "task": true }, { "name": "listRouterConntrackHelpers", "summary": "List router conntrack helpers", "description": "List router conntrack helpers", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "helper", "type": "string", "info": "Filter the list result by the used helper.: string", "required": false, "schema": { "title": "helper", "type": "string" } }, { "name": "protocol", "type": "string", "info": "Filter the list result by the used protocol.: string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "port", "type": "number", "info": "Filter the list result by the used port.: 123", "required": false, "schema": { "title": "port", "type": "number" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a conntrack helper ID attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRouterConntrackHelpers" }, "task": true }, { "name": "createConntrackHelper", "summary": "Create conntrack helper", "description": "Create conntrack helper", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"conntrack_helper\": {\"protocol\": \"string\", \"port\": 123, \"helper\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "conntrack_helper": { "type": "object", "properties": { "protocol": { "type": "string" }, "port": { "type": "integer" }, "helper": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createConntrackHelper" }, "task": true }, { "name": "listFloatingIPs", "summary": "List floating IPs", "description": "List floating IPs", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "routerId", "type": "string", "info": "Filter the floating IP list result by the ID of the router for the\nfloating IP.: string", "required": false, "schema": { "title": "routerId", "type": "string" } }, { "name": "status", "type": "string", "info": "Filter the floating IP list result by the status of the floating IP.\nValues are ACTIVE, DOWN and ERROR.: string", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "floatingNetworkId", "type": "string", "info": "Filter the floating IP list result by the ID of the network associated\nwith the floating IP.: string", "required": false, "schema": { "title": "floatingNetworkId", "type": "string" } }, { "name": "fixedIpAddress", "type": "string", "info": "Filter the floating IP list result by the fixed IP address that\nis associated with the floating IP address.: string", "required": false, "schema": { "title": "fixedIpAddress", "type": "string" } }, { "name": "floatingIpAddress", "type": "string", "info": "Filter the floating IP list result by the floating IP address.: string", "required": false, "schema": { "title": "floatingIpAddress", "type": "string" } }, { "name": "portId", "type": "string", "info": "Filter the floating IP list result by the ID of a port associated with\nthe floating IP.: string", "required": false, "schema": { "title": "portId", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a floatingip attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFloatingIPs" }, "task": true }, { "name": "createFloatingIP", "summary": "Create floating IP", "description": "Create floating IP", "input": [ { "name": "body", "type": "object", "info": ": {\"floatingip\": {\"floating_network_id\": \"string\", \"port_id\": \"string\", \"subnet_id\": \"string\", \"fixed_ip_address\": \"string\", \"floating_ip_address\": \"string\", \"description\": \"string\", \"dns_domain\": \"string\", \"dns_name\": \"string\", \"qos_policy_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "floatingip": { "type": "object", "properties": { "floating_network_id": { "type": "string" }, "port_id": { "type": "string" }, "subnet_id": { "type": "string" }, "fixed_ip_address": { "type": "string" }, "floating_ip_address": { "type": "string" }, "description": { "type": "string" }, "dns_domain": { "type": "string" }, "dns_name": { "type": "string" }, "qos_policy_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFloatingIP" }, "task": true }, { "name": "showFloatingIPDetails", "summary": "Show floating IP details", "description": "Show floating IP details", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFloatingIPDetails" }, "task": true }, { "name": "updateFloatingIP", "summary": "Update floating IP", "description": "Update floating IP", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"floatingip\": {\"port_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "floatingip": { "type": "object", "properties": { "port_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFloatingIP" }, "task": true }, { "name": "deleteFloatingIP", "summary": "Delete floating IP", "description": "Delete floating IP", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFloatingIP" }, "task": true }, { "name": "listFloatingIPPools", "summary": "List floating IP Pools", "description": "List floating IP Pools", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listFloatingIPPools" }, "task": true }, { "name": "showPortForwarding", "summary": "Show port forwarding", "description": "Show port forwarding", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } }, { "name": "portForwardingId", "type": "string", "info": "The ID of the floating IP port forwarding.: string", "required": true, "schema": { "title": "portForwardingId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPortForwarding" }, "task": true }, { "name": "updateAPortForwarding", "summary": "Update a port forwarding", "description": "Update a port forwarding", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } }, { "name": "portForwardingId", "type": "string", "info": "The ID of the floating IP port forwarding.: string", "required": true, "schema": { "title": "portForwardingId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port_forwarding\": {\"protocol\": \"string\", \"internal_port\": 123, \"internal_port_id\": \"string\", \"external_port\": 123, \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "port_forwarding": { "type": "object", "properties": { "protocol": { "type": "string" }, "internal_port": { "type": "integer" }, "internal_port_id": { "type": "string" }, "external_port": { "type": "integer" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAPortForwarding" }, "task": true }, { "name": "deleteAFloatingIPPortForwarding", "summary": "Delete a floating IP port forwarding", "description": "Delete a floating IP port forwarding", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } }, { "name": "portForwardingId", "type": "string", "info": "The ID of the floating IP port forwarding.: string", "required": true, "schema": { "title": "portForwardingId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAFloatingIPPortForwarding" }, "task": true }, { "name": "listFloatingIPPortForwardings", "summary": "List floating IP port forwardings", "description": "List floating IP port forwardings", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "internalPortId", "type": "string", "info": "Filter the list result by the ID of the internal Neutron port.: string", "required": false, "schema": { "title": "internalPortId", "type": "string" } }, { "name": "externalPort", "type": "number", "info": "Filter the list result by the TCP/UDP/other protocol port number of the\nfloating IP.: 123", "required": false, "schema": { "title": "externalPort", "type": "number" } }, { "name": "externalPortRange", "type": "string", "info": "Filter the list result by the TCP/UDP/other protocol port range of the\nfloating IP.: string", "required": false, "schema": { "title": "externalPortRange", "type": "string" } }, { "name": "protocol", "type": "string", "info": "Filter the list result by the used protocol.: string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a floating IP port forwarding attribute. You can specify multiple\npairs of sort key and sort direction query parameters. The sort keys are\nlimited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFloatingIPPortForwardings" }, "task": true }, { "name": "createPortForwarding", "summary": "Create port forwarding", "description": "Create port forwarding", "input": [ { "name": "floatingipId", "type": "string", "info": "The ID of the floating IP address.: string", "required": true, "schema": { "title": "floatingipId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port_forwarding\": {\"protocol\": \"string\", \"internal_ip_address\": \"string\", \"internal_port\": 123, \"internal_port_id\": \"string\", \"external_port\": 123, \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "port_forwarding": { "type": "object", "properties": { "protocol": { "type": "string" }, "internal_ip_address": { "type": "string" }, "internal_port": { "type": "integer" }, "internal_port_id": { "type": "string" }, "external_port": { "type": "integer" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPortForwarding" }, "task": true }, { "name": "listRouters", "summary": "List routers", "description": "List routers", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "adminStateUp", "type": "boolean", "info": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).: boolean", "required": false, "schema": { "title": "adminStateUp", "type": "boolean" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a router attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRouters" }, "task": true }, { "name": "createRouter", "summary": "Create router", "description": "Create router", "input": [ { "name": "body", "type": "object", "info": ": {\"router\": {\"name\": \"string\", \"external_gateway_info\": {\"network_id\": \"string\", \"enable_snat\": \"boolean\", \"external_fixed_ips\": [{\"ip_address\": \"string\", \"subnet_id\": \"string\"}]}, \"admin_state_up\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "router": { "type": "object", "properties": { "name": { "type": "string" }, "external_gateway_info": { "type": "object", "properties": { "network_id": { "type": "string" }, "enable_snat": { "type": "boolean" }, "external_fixed_ips": { "type": "array", "items": { "type": "object", "properties": { "ip_address": { "type": "string" }, "subnet_id": { "type": "string" } } } } } }, "admin_state_up": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouter" }, "task": true }, { "name": "showRouterDetails", "summary": "Show router details", "description": "Show router details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRouterDetails" }, "task": true }, { "name": "updateRouter", "summary": "Update router", "description": "Update router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router\": {\"distributed\": \"boolean\", \"external_gateway_info\": {\"network_id\": \"string\", \"enable_snat\": \"boolean\", \"external_fixed_ips\": [{\"ip_address\": \"string\", \"subnet_id\": \"string\"}], \"routes\": [{\"destination\": \"string\", \"nexthop\": \"string\"}]}}}", "required": false, "schema": { "type": "object", "properties": { "router": { "type": "object", "properties": { "distributed": { "type": "boolean" }, "external_gateway_info": { "type": "object", "properties": { "network_id": { "type": "string" }, "enable_snat": { "type": "boolean" }, "external_fixed_ips": { "type": "array", "items": { "type": "object", "properties": { "ip_address": { "type": "string" }, "subnet_id": { "type": "string" } } } }, "routes": { "type": "array", "items": { "type": "object", "properties": { "destination": { "type": "string" }, "nexthop": { "type": "string" } } } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRouter" }, "task": true }, { "name": "deleteRouter", "summary": "Delete router", "description": "Delete router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouter" }, "task": true }, { "name": "addInterfaceToRouter", "summary": "Add interface to router", "description": "Add interface to router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"subnet_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "subnet_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addInterfaceToRouter" }, "task": true }, { "name": "removeInterfaceFromRouter", "summary": "Remove interface from router", "description": "Remove interface from router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"subnet_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "subnet_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeInterfaceFromRouter" }, "task": true }, { "name": "addExtraRoutesToRouter", "summary": "Add extra routes to router", "description": "Add extra routes to router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router\": {\"routes\": [{\"destination\": \"string\", \"nexthop\": \"string\"}]}}", "required": false, "schema": { "type": "object", "properties": { "router": { "type": "object", "properties": { "routes": { "type": "array", "items": { "type": "object", "properties": { "destination": { "type": "string" }, "nexthop": { "type": "string" } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addExtraRoutesToRouter" }, "task": true }, { "name": "removeExtraRoutesFromRouter", "summary": "Remove extra routes from router", "description": "Remove extra routes from router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router\": {\"routes\": [{\"destination\": \"string\", \"nexthop\": \"string\"}]}}", "required": false, "schema": { "type": "object", "properties": { "router": { "type": "object", "properties": { "routes": { "type": "array", "items": { "type": "object", "properties": { "destination": { "type": "string" }, "nexthop": { "type": "string" } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeExtraRoutesFromRouter" }, "task": true }, { "name": "listNdpProxies", "summary": "List ndp proxies", "description": "List ndp proxies", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "routerId", "type": "string", "info": "The ID of the router for the ndp proxy.: string", "required": false, "schema": { "title": "routerId", "type": "string" } }, { "name": "portId", "type": "string", "info": "The ID of the port for the ndp proxy.: string", "required": false, "schema": { "title": "portId", "type": "string" } }, { "name": "ipAddress", "type": "string", "info": "The IPv6 address which the ndp proxy annunciate to external network.: string", "required": false, "schema": { "title": "ipAddress", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a ndp proxy attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNdpProxies" }, "task": true }, { "name": "createNdpProxy", "summary": "Create ndp proxy", "description": "Create ndp proxy", "input": [ { "name": "body", "type": "object", "info": ": {\"ndp_proxy\": {\"name\": \"string\", \"router_id\": \"string\", \"port_id\": \"string\", \"ip_address\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ndp_proxy": { "type": "object", "properties": { "name": { "type": "string" }, "router_id": { "type": "string" }, "port_id": { "type": "string" }, "ip_address": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNdpProxy" }, "task": true }, { "name": "showNdpProxyDetails", "summary": "Show ndp proxy details", "description": "Show ndp proxy details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "ndpProxyId", "type": "string", "info": "The ID of the ndp proxy.: string", "required": true, "schema": { "title": "ndpProxyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNdpProxyDetails" }, "task": true }, { "name": "updateANdpProxy", "summary": "Update a ndp proxy", "description": "Update a ndp proxy", "input": [ { "name": "ndpProxyId", "type": "string", "info": "The ID of the ndp proxy.: string", "required": true, "schema": { "title": "ndpProxyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ndp_proxy\": {\"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ndp_proxy": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateANdpProxy" }, "task": true }, { "name": "deleteANdpProxy", "summary": "Delete a ndp proxy", "description": "Delete a ndp proxy", "input": [ { "name": "ndpProxyId", "type": "string", "info": "The ID of the ndp proxy.: string", "required": true, "schema": { "title": "ndpProxyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteANdpProxy" }, "task": true }, { "name": "showSubnetPool", "summary": "Show subnet pool", "description": "Show subnet pool", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "subnetpoolId", "type": "string", "info": "The UUID of the subnet pool.: string", "required": true, "schema": { "title": "subnetpoolId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSubnetPool" }, "task": true }, { "name": "updateSubnetPool", "summary": "Update subnet pool", "description": "Update subnet pool", "input": [ { "name": "subnetpoolId", "type": "string", "info": "The UUID of the subnet pool.: string", "required": true, "schema": { "title": "subnetpoolId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"subnetpool\": {\"name\": \"string\", \"prefixes\": \"array\", \"min_prefixlen\": 123, \"default_prefixlen\": 123, \"max_prefixlen\": 123}}", "required": false, "schema": { "type": "object", "properties": { "subnetpool": { "type": "object", "properties": { "name": { "type": "string" }, "prefixes": { "type": "array", "items": { "type": "string" } }, "min_prefixlen": { "type": "integer" }, "default_prefixlen": { "type": "integer" }, "max_prefixlen": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSubnetPool" }, "task": true }, { "name": "deleteSubnetPool", "summary": "Delete subnet pool", "description": "Delete subnet pool", "input": [ { "name": "subnetpoolId", "type": "string", "info": "The UUID of the subnet pool.: string", "required": true, "schema": { "title": "subnetpoolId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnetPool" }, "task": true }, { "name": "listSubnetPools", "summary": "List subnet pools", "description": "List subnet pools", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "defaultQuota", "type": "number", "info": "Filter the subnet pool list result by the quota on the prefix space\nthat can be allocated from the subnet pool for project subnets.: 123", "required": false, "schema": { "title": "defaultQuota", "type": "number" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "minPrefixlen", "type": "number", "info": "Filter the subnet pool list result by the smallest prefix that can be\nallocated from a subnet pool.: 123", "required": false, "schema": { "title": "minPrefixlen", "type": "number" } }, { "name": "addressScopeId", "type": "string", "info": "Filter the subnet pool list result by the address scope that is assigned\nto the subnet pool.: string", "required": false, "schema": { "title": "addressScopeId", "type": "string" } }, { "name": "ipVersion", "type": "number", "info": "Filter the list result by the IP protocol version.\nValid value is 4 or 6.: 123", "required": false, "schema": { "title": "ipVersion", "type": "number" } }, { "name": "shared", "type": "boolean", "info": "Admin-only. Filter the list result based on whether the resource is\nshared across all projects.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "defaultPrefixlen", "type": "number", "info": "Filter the subnet pool list result by the size of the prefix to allocate\nwhen the cidr or prefixlen attributes are omitted when you create\nthe subnet. Default is min_pref...(description truncated): 123", "required": false, "schema": { "title": "defaultPrefixlen", "type": "number" } }, { "name": "maxPrefixlen", "type": "number", "info": "Filter the subnet pool list result by the maximum prefix size that can be\nallocated from the subnet pool.: 123", "required": false, "schema": { "title": "maxPrefixlen", "type": "number" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "isDefault", "type": "boolean", "info": "Filter the subnet pool list result based on if it is a default pool or not.: boolean", "required": false, "schema": { "title": "isDefault", "type": "boolean" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a subnetpool attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSubnetPools" }, "task": true }, { "name": "createSubnetPool", "summary": "Create subnet pool", "description": "Create subnet pool", "input": [ { "name": "body", "type": "object", "info": ": {\"subnetpool\": {\"name\": \"string\", \"prefixes\": \"array\", \"default_prefixlen\": 123, \"min_prefixlen\": 123, \"max_prefixlen\": 123, \"shared\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "subnetpool": { "type": "object", "properties": { "name": { "type": "string" }, "prefixes": { "type": "array", "items": { "type": "string" } }, "default_prefixlen": { "type": "integer" }, "min_prefixlen": { "type": "integer" }, "max_prefixlen": { "type": "integer" }, "shared": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnetPool" }, "task": true }, { "name": "addPrefixes", "summary": "Add prefixes", "description": "Add prefixes", "input": [ { "name": "subnetpoolId", "type": "string", "info": "The UUID of the subnet pool.: string", "required": true, "schema": { "title": "subnetpoolId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"prefixes\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "type": "string" } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addPrefixes" }, "task": true }, { "name": "removePrefixes", "summary": "Remove prefixes", "description": "Remove prefixes", "input": [ { "name": "subnetpoolId", "type": "string", "info": "The UUID of the subnet pool.: string", "required": true, "schema": { "title": "subnetpoolId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"prefixes\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "type": "string" } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removePrefixes" }, "task": true }, { "name": "listSubnets", "summary": "List subnets", "description": "List subnets", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "enableDhcp", "type": "boolean", "info": "Filter the subnet list result based on if DHCP is enabled or disabled\nfor the subnet.: boolean", "required": false, "schema": { "title": "enableDhcp", "type": "boolean" } }, { "name": "networkId", "type": "string", "info": "Filter the subnet list result by the ID of the network to which\nthe subnet belongs.: string", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "ipVersion", "type": "number", "info": "Filter the subnet list result by the IP protocol version.\nValue is 4 or 6.: 123", "required": false, "schema": { "title": "ipVersion", "type": "number" } }, { "name": "gatewayIp", "type": "string", "info": "Filter the subnet list result by the gateway IP of this subnet.: string", "required": false, "schema": { "title": "gatewayIp", "type": "string" } }, { "name": "cidr", "type": "string", "info": "Filter the subnet list result by the CIDR of the subnet.: string", "required": false, "schema": { "title": "cidr", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "ipv6AddressMode", "type": "string", "info": "Filter the subnet list result by the IPv6 address modes specifies\nmechanisms for assigning IP addresses.\nValue is slaac, dhcpv6-stateful, dhcpv6-stateless or null.: string", "required": false, "schema": { "title": "ipv6AddressMode", "type": "string" } }, { "name": "ipv6RaMode", "type": "string", "info": "Filter the subnet list result by the IPv6 router advertisement specifies\nwhether the networking service should transmit ICMPv6 packets for a subnet.\nValue is slaac, dhcpv...(description truncated): string", "required": false, "schema": { "title": "ipv6RaMode", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "segmentId", "type": "string", "info": "Filter the subnet list result by the ID of a network segment the subnet\nis associated with.\nIt is available when segment extension is enabled.: string", "required": false, "schema": { "title": "segmentId", "type": "string" } }, { "name": "shared", "type": "boolean", "info": "Admin-only. Filter the list result based on whether the resource is\nshared across all projects.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a subnet attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "subnetpoolId", "type": "string", "info": "Filter the subnet list result by the ID of the subnet pool associated\nwith the subnet.: string", "required": false, "schema": { "title": "subnetpoolId", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "dnsPublishFixedIp", "type": "boolean", "info": "Filter the subnet list result based on if dns_publish_fixed_ip is\nenabled or disabled for the subnet.: boolean", "required": false, "schema": { "title": "dnsPublishFixedIp", "type": "boolean" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSubnets" }, "task": true }, { "name": "createSubnet", "summary": "Create subnet", "description": "Create subnet", "input": [ { "name": "body", "type": "object", "info": ": {\"subnet\": {\"network_id\": \"string\", \"ip_version\": 123, \"cidr\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "subnet": { "type": "object", "properties": { "network_id": { "type": "string" }, "ip_version": { "type": "integer" }, "cidr": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubnet" }, "task": true }, { "name": "showSubnetDetails", "summary": "Show subnet details", "description": "Show subnet details", "input": [ { "name": "subnetId", "type": "string", "info": "The ID of the subnet.: string", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSubnetDetails" }, "task": true }, { "name": "updateSubnet", "summary": "Update subnet", "description": "Update subnet", "input": [ { "name": "subnetId", "type": "string", "info": "The ID of the subnet.: string", "required": true, "schema": { "title": "subnetId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"subnet\": {\"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "subnet": { "type": "object", "properties": { "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSubnet" }, "task": true }, { "name": "deleteSubnet", "summary": "Delete subnet", "description": "Delete subnet", "input": [ { "name": "subnetId", "type": "string", "info": "The ID of the subnet.: string", "required": true, "schema": { "title": "subnetId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSubnet" }, "task": true }, { "name": "listLocalIPs", "summary": "List Local IPs", "description": "List Local IPs", "input": [ { "name": "id", "type": "string", "info": "Filter the Local IP list result by ID of Local IP: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "localPortId", "type": "string", "info": "Filter the Local IP list result by ID of underlying Neutron port: string", "required": false, "schema": { "title": "localPortId", "type": "string" } }, { "name": "networkId", "type": "string", "info": "Filter the list result by the ID of the attached network.: string", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "localIpAddress", "type": "string", "info": "Filter the Local IP list result by IP address: string", "required": false, "schema": { "title": "localIpAddress", "type": "string" } }, { "name": "ipMode", "type": "string", "info": "Filter the Local IP list result by IP mode.\nPossible values are translate (DNAT) and passthrough (no DNAT): string", "required": false, "schema": { "title": "ipMode", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a Local IP attribute. You can specify multiple pairs of sort\nkey and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listLocalIPs" }, "task": true }, { "name": "createLocalIP", "summary": "Create Local IP", "description": "Create Local IP", "input": [ { "name": "body", "type": "object", "info": ": {\"local_ip\": {\"name\": \"string\", \"description\": \"string\", \"network_id\": \"string\", \"local_ip_address\": \"string\", \"ip_mode\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "local_ip": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "network_id": { "type": "string" }, "local_ip_address": { "type": "string" }, "ip_mode": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLocalIP" }, "task": true }, { "name": "showLocalIPDetails", "summary": "Show Local IP details", "description": "Show Local IP details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLocalIPDetails" }, "task": true }, { "name": "updateLocalIP", "summary": "Update Local IP", "description": "Update Local IP", "input": [ { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"local_ip\": {\"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "local_ip": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateLocalIP" }, "task": true }, { "name": "deleteLocalIP", "summary": "Delete Local IP", "description": "Delete Local IP", "input": [ { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLocalIP" }, "task": true }, { "name": "listLocalIPAssociations", "summary": "List Local IP Associations", "description": "List Local IP Associations", "input": [ { "name": "fixedPortId", "type": "string", "info": "Filter the Local IP Association list result by ID of associated ports: string", "required": false, "schema": { "title": "fixedPortId", "type": "string" } }, { "name": "fixedIp", "type": "string", "info": "Filter the Local IP Association list result by IP of associated ports: string", "required": false, "schema": { "title": "fixedIp", "type": "string" } }, { "name": "host", "type": "string", "info": "Filter the Local IP Association list result by host of associated ports: string", "required": false, "schema": { "title": "host", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a Local IP Association attribute. You can specify multiple pairs\nof sort key and sort direction query parameters.\nThe sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listLocalIPAssociations" }, "task": true }, { "name": "createLocalIPAssociation", "summary": "Create Local IP Association", "description": "Create Local IP Association", "input": [ { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port_association\": {\"fixed_port_id\": \"string\", \"fixed_ip\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "port_association": { "type": "object", "properties": { "fixed_port_id": { "type": "string" }, "fixed_ip": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLocalIPAssociation" }, "task": true }, { "name": "deleteLocalIPAssociation", "summary": "Delete Local IP Association", "description": "Delete Local IP Association", "input": [ { "name": "localIpId", "type": "string", "info": "The ID of the Local IP: string", "required": true, "schema": { "title": "localIpId", "type": "string" } }, { "name": "fixedPortId", "type": "string", "info": "The ID of the port associated with the Local IP.: string", "required": true, "schema": { "title": "fixedPortId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLocalIPAssociation" }, "task": true }, { "name": "showAddressGroup", "summary": "Show address group", "description": "Show address group", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressGroup" }, "task": true }, { "name": "createAddressGroup", "summary": "Create address group", "description": "Create address group", "input": [ { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address_group\": {\"addresses\": \"array\", \"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "address_group": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "items": {} } }, "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createAddressGroup" }, "task": true }, { "name": "updateAnAddressGroup", "summary": "Update an address group", "description": "Update an address group", "input": [ { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address_group\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "address_group": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAnAddressGroup" }, "task": true }, { "name": "deleteAnAddressGroup", "summary": "Delete an address group", "description": "Delete an address group", "input": [ { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAnAddressGroup" }, "task": true }, { "name": "listAddressGroups", "summary": "List address groups", "description": "List address groups", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by an address group attribute. You can specify multiple pairs of sort\nkey and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAddressGroups" }, "task": true }, { "name": "addIPAddressesToAddressGroup", "summary": "Add IP addresses to address group", "description": "Add IP addresses to address group", "input": [ { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address_group\": {\"addresses\": \"array\"}}", "required": false, "schema": { "type": "object", "properties": { "address_group": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addIPAddressesToAddressGroup" }, "task": true }, { "name": "removeIPAddressesToAddressGroup", "summary": "Remove IP addresses to address group", "description": "Remove IP addresses to address group", "input": [ { "name": "addressGroupId", "type": "string", "info": "The ID of the address group.: string", "required": true, "schema": { "title": "addressGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"address_group\": {\"addresses\": \"array\"}}", "required": false, "schema": { "type": "object", "properties": { "address_group": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeIPAddressesToAddressGroup" }, "task": true }, { "name": "listFirewallGroups", "summary": "List firewall groups", "description": "List firewall groups", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFirewallGroups" }, "task": true }, { "name": "createFirewallGroup", "summary": "Create firewall group", "description": "Create firewall group", "input": [ { "name": "body", "type": "object", "info": ": {\"firewall_group\": {\"admin_state_up\": \"boolean\", \"egress_firewall_policy_id\": \"string\", \"ingress_firewall_policy_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_group": { "type": "object", "properties": { "admin_state_up": { "type": "boolean" }, "egress_firewall_policy_id": { "type": "string" }, "ingress_firewall_policy_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFirewallGroup" }, "task": true }, { "name": "showFirewallGroupDetails", "summary": "Show firewall group details", "description": "Show firewall group details", "input": [ { "name": "firewallGroupId", "type": "string", "info": "The ID of the firewall group.: string", "required": true, "schema": { "title": "firewallGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFirewallGroupDetails" }, "task": true }, { "name": "updateFirewallGroup", "summary": "Update firewall group", "description": "Update firewall group", "input": [ { "name": "firewallGroupId", "type": "string", "info": "The ID of the firewall group.: string", "required": true, "schema": { "title": "firewallGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_group\": {\"admin_state_up\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_group": { "type": "object", "properties": { "admin_state_up": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFirewallGroup" }, "task": true }, { "name": "deleteFirewallGroup", "summary": "Delete firewall group", "description": "Delete firewall group", "input": [ { "name": "firewallGroupId", "type": "string", "info": "The ID of the firewall group.: string", "required": true, "schema": { "title": "firewallGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFirewallGroup" }, "task": true }, { "name": "listFirewallPolicies", "summary": "List firewall policies", "description": "List firewall policies", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFirewallPolicies" }, "task": true }, { "name": "createFirewallPolicy", "summary": "Create firewall policy", "description": "Create firewall policy", "input": [ { "name": "body", "type": "object", "info": ": {\"firewall_policy\": {\"name\": \"string\", \"firewall_rules\": \"array\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_policy": { "type": "object", "properties": { "name": { "type": "string" }, "firewall_rules": { "type": "array", "items": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFirewallPolicy" }, "task": true }, { "name": "showFirewallPolicyDetails", "summary": "Show firewall policy details", "description": "Show firewall policy details", "input": [ { "name": "firewallPolicyId", "type": "string", "info": "The ID of the firewall policy.: string", "required": true, "schema": { "title": "firewallPolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFirewallPolicyDetails" }, "task": true }, { "name": "updateFirewallPolicy", "summary": "Update firewall policy", "description": "Update firewall policy", "input": [ { "name": "firewallPolicyId", "type": "string", "info": "The ID of the firewall policy.: string", "required": true, "schema": { "title": "firewallPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_policy\": {\"firewall_rules\": \"array\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_policy": { "type": "object", "properties": { "firewall_rules": { "type": "array", "items": { "type": "string" } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFirewallPolicy" }, "task": true }, { "name": "deleteFirewallPolicy", "summary": "Delete firewall policy", "description": "Delete firewall policy", "input": [ { "name": "firewallPolicyId", "type": "string", "info": "The ID of the firewall policy.: string", "required": true, "schema": { "title": "firewallPolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFirewallPolicy" }, "task": true }, { "name": "listFirewallRules", "summary": "List firewall rules", "description": "List firewall rules", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFirewallRules" }, "task": true }, { "name": "createFirewallRule", "summary": "Create firewall rule", "description": "Create firewall rule", "input": [ { "name": "body", "type": "object", "info": ": {\"firewall_rule\": {\"action\": \"string\", \"destination_port\": \"string\", \"enabled\": \"boolean\", \"name\": \"string\", \"protocol\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_rule": { "type": "object", "properties": { "action": { "type": "string" }, "destination_port": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "protocol": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFirewallRule" }, "task": true }, { "name": "showFirewallRuleDetails", "summary": "Show firewall rule details", "description": "Show firewall rule details", "input": [ { "name": "firewallRuleId", "type": "string", "info": "The ID for the firewall rule.: string", "required": true, "schema": { "title": "firewallRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFirewallRuleDetails" }, "task": true }, { "name": "updateFirewallRule", "summary": "Update firewall rule", "description": "Update firewall rule", "input": [ { "name": "firewallRuleId", "type": "string", "info": "The ID for the firewall rule.: string", "required": true, "schema": { "title": "firewallRuleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_rule\": {\"shared\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_rule": { "type": "object", "properties": { "shared": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFirewallRule" }, "task": true }, { "name": "deleteFirewallRule", "summary": "Delete firewall rule", "description": "Delete firewall rule", "input": [ { "name": "firewallRuleId", "type": "string", "info": "The ID for the firewall rule.: string", "required": true, "schema": { "title": "firewallRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFirewallRule" }, "task": true }, { "name": "insertRuleIntoAFirewallPolicy", "summary": "Insert rule into a firewall policy", "description": "Insert rule into a firewall policy", "input": [ { "name": "firewallPolicyId", "type": "string", "info": "The ID of the firewall policy.: string", "required": true, "schema": { "title": "firewallPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_rule_id\": \"string\", \"insert_after\": \"string\", \"insert_before\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "firewall_rule_id": { "type": "string" }, "insert_after": { "type": "string" }, "insert_before": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/insertRuleIntoAFirewallPolicy" }, "task": true }, { "name": "removeRuleFromFirewallPolicy", "summary": "Remove rule from firewall policy", "description": "Remove rule from firewall policy", "input": [ { "name": "firewallPolicyId", "type": "string", "info": "The ID of the firewall policy.: string", "required": true, "schema": { "title": "firewallPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_rule_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "firewall_rule_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeRuleFromFirewallPolicy" }, "task": true }, { "name": "showRBACPolicyDetails", "summary": "Show RBAC policy details", "description": "Show RBAC policy details", "input": [ { "name": "rbacPolicyId", "type": "string", "info": "The ID of the RBAC policy.: string", "required": true, "schema": { "title": "rbacPolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRBACPolicyDetails" }, "task": true }, { "name": "updateRBACPolicy", "summary": "Update RBAC policy", "description": "Update RBAC policy", "input": [ { "name": "rbacPolicyId", "type": "string", "info": "The ID of the RBAC policy.: string", "required": true, "schema": { "title": "rbacPolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"rbac_policy\": {\"target_tenant\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "rbac_policy": { "type": "object", "properties": { "target_tenant": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRBACPolicy" }, "task": true }, { "name": "deleteRBACPolicy", "summary": "Delete RBAC policy", "description": "Delete RBAC policy", "input": [ { "name": "rbacPolicyId", "type": "string", "info": "The ID of the RBAC policy.: string", "required": true, "schema": { "title": "rbacPolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRBACPolicy" }, "task": true }, { "name": "listRBACPolicies", "summary": "List RBAC policies", "description": "List RBAC policies", "input": [ { "name": "targetTenant", "type": "string", "info": "Filter the RBAC policy list result by the ID of the tenant to which the\nRBAC policy will be enforced.: string", "required": false, "schema": { "title": "targetTenant", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "objectType", "type": "string", "info": "Filter the RBAC policy list result by the type of the object that the\nRBAC policy affects. Types include qos-policy, network,\nsecurity-group, address-scope, subnetpool, a...(description truncated): string", "required": false, "schema": { "title": "objectType", "type": "string" } }, { "name": "objectId", "type": "string", "info": "Filter the RBAC policy list result by the ID of the object_type\nresource. An object_type of network returns a network ID,\nan object_type of qos-policy returns a QoS polic...(description truncated): string", "required": false, "schema": { "title": "objectId", "type": "string" } }, { "name": "action", "type": "string", "info": "Filter the RBAC policy list result by the action for the RBAC policy\nwhich is access_as_external or access_as_shared.: string", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a RBAC policy attribute. You can specify multiple pairs of sort\nkey and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRBACPolicies" }, "task": true }, { "name": "createRBACPolicy", "summary": "Create RBAC policy", "description": "Create RBAC policy", "input": [ { "name": "body", "type": "object", "info": ": {\"rbac_policy\": {\"action\": \"string\", \"object_type\": \"string\", \"target_tenant\": \"string\", \"object_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "rbac_policy": { "type": "object", "properties": { "action": { "type": "string" }, "object_type": { "type": "string" }, "target_tenant": { "type": "string" }, "object_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRBACPolicy" }, "task": true }, { "name": "listSecurityGroupRules", "summary": "List security group rules", "description": "List security group rules", "input": [ { "name": "remoteGroupId", "type": "string", "info": "Filter the security group rule list result by the ID of the remote group\nthat associates with this security group rule.: string", "required": false, "schema": { "title": "remoteGroupId", "type": "string" } }, { "name": "direction", "type": "string", "info": "Filter the security group rule list result by the direction in which\nthe security group rule is applied, which is ingress or egress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "protocol", "type": "string", "info": "Filter the security group rule list result by the IP protocol.: string", "required": false, "schema": { "title": "protocol", "type": "string" } }, { "name": "ethertype", "type": "string", "info": "Filter the security group rule list result by the ethertype of\nnetwork traffic. The value must be IPv4 or IPv6.: string", "required": false, "schema": { "title": "ethertype", "type": "string" } }, { "name": "portRangeMax", "type": "number", "info": "Filter the security group rule list result by the maximum port number\nin the range that is matched by the security group rule.: 123", "required": false, "schema": { "title": "portRangeMax", "type": "number" } }, { "name": "securityGroupId", "type": "string", "info": "Filter the security group rule list result by the ID of the security group\nthat associates with this security group rule.: string", "required": false, "schema": { "title": "securityGroupId", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "portRangeMin", "type": "number", "info": "Filter the security group rule list result by the minimum port number\nin the range that is matched by the security group rule.: 123", "required": false, "schema": { "title": "portRangeMin", "type": "number" } }, { "name": "remoteIpPrefix", "type": "string", "info": "Filter the list result by the remote IP prefix that is matched by\nthis security group rule.: string", "required": false, "schema": { "title": "remoteIpPrefix", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a security group rule attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSecurityGroupRules" }, "task": true }, { "name": "createSecurityGroupRule", "summary": "Create security group rule", "description": "Create security group rule", "input": [ { "name": "body", "type": "object", "info": ": {\"security_group_rule\": {\"direction\": \"string\", \"port_range_min\": \"string\", \"ethertype\": \"string\", \"port_range_max\": \"string\", \"protocol\": \"string\", \"remote_group_id\": \"string\", \"security_group_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "security_group_rule": { "type": "object", "properties": { "direction": { "type": "string" }, "port_range_min": { "type": "string" }, "ethertype": { "type": "string" }, "port_range_max": { "type": "string" }, "protocol": { "type": "string" }, "remote_group_id": { "type": "string" }, "security_group_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroupRule" }, "task": true }, { "name": "showSecurityGroupRule", "summary": "Show security group rule", "description": "Show security group rule", "input": [ { "name": "verbose", "type": "boolean", "info": "Show detailed information.: boolean", "required": false, "schema": { "title": "verbose", "type": "boolean" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "securityGroupRuleId", "type": "string", "info": "The ID of the security group rule.: string", "required": true, "schema": { "title": "securityGroupRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityGroupRule" }, "task": true }, { "name": "deleteSecurityGroupRule", "summary": "Delete security group rule", "description": "Delete security group rule", "input": [ { "name": "securityGroupRuleId", "type": "string", "info": "The ID of the security group rule.: string", "required": true, "schema": { "title": "securityGroupRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroupRule" }, "task": true }, { "name": "listSecurityGroups", "summary": "List security groups", "description": "List security groups", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a security group attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "shared", "type": "boolean", "info": "Filter the security group list result based on if the security group is\nshared to the requestor’s project.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listSecurityGroups" }, "task": true }, { "name": "createSecurityGroup", "summary": "Create security group", "description": "Create security group", "input": [ { "name": "body", "type": "object", "info": ": {\"security_group\": {\"name\": \"string\", \"description\": \"string\", \"stateful\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "security_group": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "stateful": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSecurityGroup" }, "task": true }, { "name": "showSecurityGroup", "summary": "Show security group", "description": "Show security group", "input": [ { "name": "verbose", "type": "boolean", "info": "Show detailed information.: boolean", "required": false, "schema": { "title": "verbose", "type": "boolean" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "securityGroupId", "type": "string", "info": "The ID of the security group.: string", "required": true, "schema": { "title": "securityGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityGroup" }, "task": true }, { "name": "updateSecurityGroup", "summary": "Update security group", "description": "Update security group", "input": [ { "name": "securityGroupId", "type": "string", "info": "The ID of the security group.: string", "required": true, "schema": { "title": "securityGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"security_group\": {\"name\": \"string\", \"description\": \"string\", \"stateful\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "security_group": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "stateful": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSecurityGroup" }, "task": true }, { "name": "deleteSecurityGroup", "summary": "Delete security group", "description": "Delete security group", "input": [ { "name": "securityGroupId", "type": "string", "info": "The ID of the security group.: string", "required": true, "schema": { "title": "securityGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityGroup" }, "task": true }, { "name": "listIKEPolicies", "summary": "List IKE policies", "description": "List IKE policies", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listIKEPolicies" }, "task": true }, { "name": "createIKEPolicy", "summary": "Create IKE policy", "description": "Create IKE policy", "input": [ { "name": "body", "type": "object", "info": ": {\"ikepolicy\": {\"phase1_negotiation_mode\": \"string\", \"auth_algorithm\": \"string\", \"encryption_algorithm\": \"string\", \"pfs\": \"string\", \"lifetime\": {\"units\": \"string\", \"value\": 123}, \"ike_version\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ikepolicy": { "type": "object", "properties": { "phase1_negotiation_mode": { "type": "string" }, "auth_algorithm": { "type": "string" }, "encryption_algorithm": { "type": "string" }, "pfs": { "type": "string" }, "lifetime": { "type": "object", "properties": { "units": { "type": "string" }, "value": { "type": "integer" } } }, "ike_version": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createIKEPolicy" }, "task": true }, { "name": "showIKEPolicyDetails", "summary": "Show IKE policy details", "description": "Show IKE policy details", "input": [ { "name": "ikepolicyId", "type": "string", "info": "The ID of the IKE policy.: string", "required": true, "schema": { "title": "ikepolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIKEPolicyDetails" }, "task": true }, { "name": "updateIKEPolicy", "summary": "Update IKE policy", "description": "Update IKE policy", "input": [ { "name": "ikepolicyId", "type": "string", "info": "The ID of the IKE policy.: string", "required": true, "schema": { "title": "ikepolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ikepolicy\": {\"encryption_algorithm\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ikepolicy": { "type": "object", "properties": { "encryption_algorithm": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateIKEPolicy" }, "task": true }, { "name": "removeIKEPolicy", "summary": "Remove IKE policy", "description": "Remove IKE policy", "input": [ { "name": "ikepolicyId", "type": "string", "info": "The ID of the IKE policy.: string", "required": true, "schema": { "title": "ikepolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeIKEPolicy" }, "task": true }, { "name": "listIPsecPolicies", "summary": "List IPsec policies", "description": "List IPsec policies", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listIPsecPolicies" }, "task": true }, { "name": "createIPsecPolicy", "summary": "Create IPsec policy", "description": "Create IPsec policy", "input": [ { "name": "body", "type": "object", "info": ": {\"ipsecpolicy\": {\"name\": \"string\", \"transform_protocol\": \"string\", \"auth_algorithm\": \"string\", \"encapsulation_mode\": \"string\", \"encryption_algorithm\": \"string\", \"pfs\": \"string\", \"lifetime\": {\"units\": \"string\", \"value\": 123}}}", "required": false, "schema": { "type": "object", "properties": { "ipsecpolicy": { "type": "object", "properties": { "name": { "type": "string" }, "transform_protocol": { "type": "string" }, "auth_algorithm": { "type": "string" }, "encapsulation_mode": { "type": "string" }, "encryption_algorithm": { "type": "string" }, "pfs": { "type": "string" }, "lifetime": { "type": "object", "properties": { "units": { "type": "string" }, "value": { "type": "integer" } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createIPsecPolicy" }, "task": true }, { "name": "showIPsecPolicy", "summary": "Show IPsec policy", "description": "Show IPsec policy", "input": [ { "name": "ipsecpolicyId", "type": "string", "info": "The ID of the IPsec policy.: string", "required": true, "schema": { "title": "ipsecpolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIPsecPolicy" }, "task": true }, { "name": "updateIPsecPolicy", "summary": "Update IPsec policy", "description": "Update IPsec policy", "input": [ { "name": "ipsecpolicyId", "type": "string", "info": "The ID of the IPsec policy.: string", "required": true, "schema": { "title": "ipsecpolicyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ipsecpolicy\": {\"pfs\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ipsecpolicy": { "type": "object", "properties": { "pfs": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateIPsecPolicy" }, "task": true }, { "name": "removeIPsecPolicy", "summary": "Remove IPsec policy", "description": "Remove IPsec policy", "input": [ { "name": "ipsecpolicyId", "type": "string", "info": "The ID of the IPsec policy.: string", "required": true, "schema": { "title": "ipsecpolicyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeIPsecPolicy" }, "task": true }, { "name": "listIPsecConnections", "summary": "List IPsec connections", "description": "List IPsec connections", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listIPsecConnections" }, "task": true }, { "name": "createIPsecConnection", "summary": "Create IPsec connection", "description": "Create IPsec connection", "input": [ { "name": "body", "type": "object", "info": ": {\"ipsec_site_connection\": {\"psk\": \"string\", \"initiator\": \"string\", \"ipsecpolicy_id\": \"string\", \"admin_state_up\": \"boolean\", \"mtu\": \"string\", \"peer_ep_group_id\": \"string\", \"ikepolicy_id\": \"string\", \"vpnservice_id\": \"string\", \"local_ep_group_id\": \"string\", \"peer_address\": \"string\", \"peer_id\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ipsec_site_connection": { "type": "object", "properties": { "psk": { "type": "string" }, "initiator": { "type": "string" }, "ipsecpolicy_id": { "type": "string" }, "admin_state_up": { "type": "boolean" }, "mtu": { "type": "string" }, "peer_ep_group_id": { "type": "string" }, "ikepolicy_id": { "type": "string" }, "vpnservice_id": { "type": "string" }, "local_ep_group_id": { "type": "string" }, "peer_address": { "type": "string" }, "peer_id": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createIPsecConnection" }, "task": true }, { "name": "showIPsecConnection", "summary": "Show IPsec connection", "description": "Show IPsec connection", "input": [ { "name": "connectionId", "type": "string", "info": "The ID of the IPsec site-to-site connection.: string", "required": true, "schema": { "title": "connectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIPsecConnection" }, "task": true }, { "name": "updateIPsecConnection", "summary": "Update IPsec connection", "description": "Update IPsec connection", "input": [ { "name": "connectionId", "type": "string", "info": "The ID of the IPsec site-to-site connection.: string", "required": true, "schema": { "title": "connectionId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"ipsec_site_connection\": {\"mtu\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "ipsec_site_connection": { "type": "object", "properties": { "mtu": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateIPsecConnection" }, "task": true }, { "name": "removeIPsecConnection", "summary": "Remove IPsec connection", "description": "Remove IPsec connection", "input": [ { "name": "connectionId", "type": "string", "info": "The ID of the IPsec site-to-site connection.: string", "required": true, "schema": { "title": "connectionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeIPsecConnection" }, "task": true }, { "name": "listVPNEndpointGroups", "summary": "List VPN endpoint groups", "description": "List VPN endpoint groups", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listVPNEndpointGroups" }, "task": true }, { "name": "createVPNEndpointGroup", "summary": "Create VPN endpoint group", "description": "Create VPN endpoint group", "input": [ { "name": "body", "type": "object", "info": ": {\"endpoint_group\": {\"endpoints\": \"array\", \"type\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "endpoint_group": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVPNEndpointGroup" }, "task": true }, { "name": "showVPNEndpointGroup", "summary": "Show VPN endpoint group", "description": "Show VPN endpoint group", "input": [ { "name": "endpointGroupId", "type": "string", "info": "The ID of the VPN endpoint group.: string", "required": true, "schema": { "title": "endpointGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVPNEndpointGroup" }, "task": true }, { "name": "updateVPNEndpointGroup", "summary": "Update VPN endpoint group", "description": "Update VPN endpoint group", "input": [ { "name": "endpointGroupId", "type": "string", "info": "The ID of the VPN endpoint group.: string", "required": true, "schema": { "title": "endpointGroupId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"endpoint_group\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "endpoint_group": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateVPNEndpointGroup" }, "task": true }, { "name": "removeVPNEndpointGroup", "summary": "Remove VPN endpoint group", "description": "Remove VPN endpoint group", "input": [ { "name": "endpointGroupId", "type": "string", "info": "The ID of the VPN endpoint group.: string", "required": true, "schema": { "title": "endpointGroupId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeVPNEndpointGroup" }, "task": true }, { "name": "listVPNServices", "summary": "List VPN services", "description": "List VPN services", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listVPNServices" }, "task": true }, { "name": "createVPNService", "summary": "Create VPN service", "description": "Create VPN service", "input": [ { "name": "body", "type": "object", "info": ": {\"vpnservice\": {\"subnet_id\": \"string\", \"router_id\": \"string\", \"name\": \"string\", \"admin_state_up\": \"boolean\", \"flavor_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "vpnservice": { "type": "object", "properties": { "subnet_id": { "type": "string" }, "router_id": { "type": "string" }, "name": { "type": "string" }, "admin_state_up": { "type": "boolean" }, "flavor_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createVPNService" }, "task": true }, { "name": "showVPNServiceDetails", "summary": "Show VPN service details", "description": "Show VPN service details", "input": [ { "name": "serviceId", "type": "string", "info": "The ID of the VPN service.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVPNServiceDetails" }, "task": true }, { "name": "updateVPNService", "summary": "Update VPN service", "description": "Update VPN service", "input": [ { "name": "serviceId", "type": "string", "info": "The ID of the VPN service.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"vpnservice\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "vpnservice": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateVPNService" }, "task": true }, { "name": "removeVPNService", "summary": "Remove VPN service", "description": "Remove VPN service", "input": [ { "name": "serviceId", "type": "string", "info": "The ID of the VPN service.: string", "required": true, "schema": { "title": "serviceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeVPNService" }, "task": true }, { "name": "listFlavors", "summary": "List flavors", "description": "List flavors", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "serviceType", "type": "string", "info": "Filter the flavor list result by the type of the flavor.: string", "required": false, "schema": { "title": "serviceType", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "enabled", "type": "boolean", "info": "Filter the flavor list result based on whether the flavor is enabled or\nnot.: boolean", "required": false, "schema": { "title": "enabled", "type": "boolean" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a flavor attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFlavors" }, "task": true }, { "name": "createFlavor", "summary": "Create flavor", "description": "Create flavor", "input": [ { "name": "body", "type": "object", "info": ": {\"flavor\": {\"service_type\": \"string\", \"enabled\": \"boolean\", \"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "flavor": { "type": "object", "properties": { "service_type": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFlavor" }, "task": true }, { "name": "showFlavorDetails", "summary": "Show flavor details", "description": "Show flavor details", "input": [ { "name": "flavorId", "type": "string", "info": "The UUID of the flavor.: string", "required": true, "schema": { "title": "flavorId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFlavorDetails" }, "task": true }, { "name": "updateFlavor", "summary": "Update flavor", "description": "Update flavor", "input": [ { "name": "flavorId", "type": "string", "info": "The UUID of the flavor.: string", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"flavor\": {\"enabled\": \"boolean\", \"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "flavor": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFlavor" }, "task": true }, { "name": "deleteFlavor", "summary": "Delete flavor", "description": "Delete flavor", "input": [ { "name": "flavorId", "type": "string", "info": "The UUID of the flavor.: string", "required": true, "schema": { "title": "flavorId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFlavor" }, "task": true }, { "name": "associateFlavorWithAServiceProfile", "summary": "Associate flavor with a service profile", "description": "Associate flavor with a service profile", "input": [ { "name": "flavorId", "type": "string", "info": "The UUID of the flavor.: string", "required": true, "schema": { "title": "flavorId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"service_profile\": {\"id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "service_profile": { "type": "object", "properties": { "id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/associateFlavorWithAServiceProfile" }, "task": true }, { "name": "disassociateAFlavor", "summary": "Disassociate a flavor.", "description": "Disassociate a flavor.", "input": [ { "name": "profileId", "type": "string", "info": "The UUID of the service profile.: string", "required": true, "schema": { "title": "profileId", "type": "string" } }, { "name": "flavorId", "type": "string", "info": "The UUID of the flavor.: string", "required": true, "schema": { "title": "flavorId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disassociateAFlavor" }, "task": true }, { "name": "listServiceProfiles", "summary": "List service profiles", "description": "List service profiles", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "enabled", "type": "boolean", "info": "Filter the service profile list result based on whether this service\nprofile is enabled or not.: boolean", "required": false, "schema": { "title": "enabled", "type": "boolean" } }, { "name": "driver", "type": "string", "info": "Filter the service profile list result by the driver that this profile\nuses.: string", "required": false, "schema": { "title": "driver", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a service profile attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listServiceProfiles" }, "task": true }, { "name": "createServiceProfile", "summary": "Create service profile", "description": "Create service profile", "input": [ { "name": "body", "type": "object", "info": ": {\"service_profile\": {\"enabled\": \"string\", \"driver\": \"string\", \"description\": \"string\", \"metainfo\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "service_profile": { "type": "object", "properties": { "enabled": { "type": "string" }, "driver": { "type": "string" }, "description": { "type": "string" }, "metainfo": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createServiceProfile" }, "task": true }, { "name": "showServiceProfileDetails", "summary": "Show service profile details", "description": "Show service profile details", "input": [ { "name": "profileId", "type": "string", "info": "The UUID of the service profile.: string", "required": true, "schema": { "title": "profileId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceProfileDetails" }, "task": true }, { "name": "updateServiceProfile", "summary": "Update service profile", "description": "Update service profile", "input": [ { "name": "profileId", "type": "string", "info": "The UUID of the service profile.: string", "required": true, "schema": { "title": "profileId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"service_profile\": {\"enabled\": \"boolean\", \"driver\": \"string\", \"description\": \"string\", \"metainfo\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "service_profile": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "driver": { "type": "string" }, "description": { "type": "string" }, "metainfo": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateServiceProfile" }, "task": true }, { "name": "deleteServiceProfile", "summary": "Delete service profile", "description": "Delete service profile", "input": [ { "name": "profileId", "type": "string", "info": "The UUID of the service profile.: string", "required": true, "schema": { "title": "profileId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceProfile" }, "task": true }, { "name": "listMeteringLabels", "summary": "List metering labels", "description": "List metering labels", "input": [ { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "shared", "type": "boolean", "info": "Admin-only. Filter the list result based on whether the resource is\nshared across all projects.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a metering label attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listMeteringLabels" }, "task": true }, { "name": "createMeteringLabel", "summary": "Create metering label", "description": "Create metering label", "input": [ { "name": "body", "type": "object", "info": ": {\"metering_label\": {\"name\": \"string\", \"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "metering_label": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMeteringLabel" }, "task": true }, { "name": "showMeteringLabelDetails", "summary": "Show metering label details", "description": "Show metering label details", "input": [ { "name": "meteringLabelId", "type": "string", "info": "The ID of the metering label.: string", "required": true, "schema": { "title": "meteringLabelId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMeteringLabelDetails" }, "task": true }, { "name": "deleteMeteringLabel", "summary": "Delete metering label", "description": "Delete metering label", "input": [ { "name": "meteringLabelId", "type": "string", "info": "The ID of the metering label.: string", "required": true, "schema": { "title": "meteringLabelId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMeteringLabel" }, "task": true }, { "name": "listMeteringLabelRules", "summary": "List metering label rules", "description": "List metering label rules", "input": [ { "name": "direction", "type": "string", "info": "Filter the metering rule list result by the direction in\nwhich the metering rule is applied, which is ingress or egress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "remoteIpPrefix", "type": "string", "info": "(deprecated) Filter the metering rule list result by the source IP prefix\nthat the metering rule associates with. By source IP prefix, one should\nread the internal/privat...(description truncated): string", "required": false, "schema": { "title": "remoteIpPrefix", "type": "string" } }, { "name": "sourceIpPrefix", "type": "string", "info": "The source IP prefix that the metering rule is associated with; in this\ncontext, source IP prefix represents the source IP of the network packet.\nTherefore, for an ingres...(description truncated): string", "required": false, "schema": { "title": "sourceIpPrefix", "type": "string" } }, { "name": "destinationIpPrefix", "type": "string", "info": "The destination IP prefix that the metering rule is associated with; in\nthis context, destination IP prefix represents the destination IP of the\nnetwork packet. Therefore...(description truncated): string", "required": false, "schema": { "title": "destinationIpPrefix", "type": "string" } }, { "name": "excluded", "type": "boolean", "info": "Filter the metering rule list result based on whether the metering\nrule exclude the traffic of a specific IP address with the\nremote_ip_prefix value.: boolean", "required": false, "schema": { "title": "excluded", "type": "boolean" } }, { "name": "meteringLabelId", "type": "string", "info": "Filter the metering rule list result by the ID of the metering label\nassociated with this metering rule.: string", "required": false, "schema": { "title": "meteringLabelId", "type": "string" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a metering label attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listMeteringLabelRules" }, "task": true }, { "name": "createMeteringLabelRule", "summary": "Create metering label rule", "description": "Create metering label rule", "input": [ { "name": "sourceIpPrefix", "type": "string", "info": "The source IP prefix that the metering rule is associated with; in this\ncontext, source IP prefix represents the source IP of the network packet.\nTherefore, for an ingres...(description truncated): string", "required": false, "schema": { "title": "sourceIpPrefix", "type": "string" } }, { "name": "destinationIpPrefix", "type": "string", "info": "The destination IP prefix that the metering rule is associated with; in\nthis context, destination IP prefix represents the destination IP of the\nnetwork packet. Therefore...(description truncated): string", "required": false, "schema": { "title": "destinationIpPrefix", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"metering_label_rule\": {\"remote_ip_prefix\": \"string\", \"direction\": \"string\", \"metering_label_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "metering_label_rule": { "type": "object", "properties": { "remote_ip_prefix": { "type": "string" }, "direction": { "type": "string" }, "metering_label_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMeteringLabelRule" }, "task": true }, { "name": "showMeteringLabelRuleDetails", "summary": "Show metering label rule details", "description": "Show metering label rule details", "input": [ { "name": "meteringLabelRuleId", "type": "string", "info": "The ID of the metering label rule.: string", "required": true, "schema": { "title": "meteringLabelRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMeteringLabelRuleDetails" }, "task": true }, { "name": "deleteMeteringLabelRule", "summary": "Delete metering label rule", "description": "Delete metering label rule", "input": [ { "name": "meteringLabelRuleId", "type": "string", "info": "The ID of the metering label rule.: string", "required": true, "schema": { "title": "meteringLabelRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMeteringLabelRule" }, "task": true }, { "name": "showNetworkIPAvailability", "summary": "Show Network IP Availability", "description": "Show Network IP Availability", "input": [ { "name": "networkId", "type": "string", "info": "The ID of the network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworkIPAvailability" }, "task": true }, { "name": "listNetworkIPAvailability", "summary": "List Network IP Availability", "description": "List Network IP Availability", "input": [ { "name": "networkId", "type": "string", "info": "Filter the list result by the ID of the network whose IP availability\ndetail is reported.: string", "required": false, "schema": { "title": "networkId", "type": "string" } }, { "name": "networkName", "type": "string", "info": "Filter the list result by the human-readable name of the network.: string", "required": false, "schema": { "title": "networkName", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "ipVersion", "type": "number", "info": "Filter the list result by the IP protocol version.\nValid value is 4 or 6.: 123", "required": false, "schema": { "title": "ipVersion", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNetworkIPAvailability" }, "task": true }, { "name": "listQuotasForProjectsWithNonDefaultQuotaValues", "summary": "List quotas for projects with non-default quota values", "description": "List quotas for projects with non-default quota values", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listQuotasForProjectsWithNonDefaultQuotaValues" }, "task": true }, { "name": "listQuotasForAProject", "summary": "List quotas for a project", "description": "List quotas for a project", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listQuotasForAProject" }, "task": true }, { "name": "updateQuotaForAProject", "summary": "Update quota for a project", "description": "Update quota for a project", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"quota\": {\"floatingip\": 123, \"network\": 123, \"port\": 123, \"rbac_policy\": 123, \"router\": 123, \"security_group\": 123, \"security_group_rule\": 123, \"subnet\": 123, \"subnetpool\": 123, \"check_limit\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "quota": { "type": "object", "properties": { "floatingip": { "type": "integer" }, "network": { "type": "integer" }, "port": { "type": "integer" }, "rbac_policy": { "type": "integer" }, "router": { "type": "integer" }, "security_group": { "type": "integer" }, "security_group_rule": { "type": "integer" }, "subnet": { "type": "integer" }, "subnetpool": { "type": "integer" }, "check_limit": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateQuotaForAProject" }, "task": true }, { "name": "resetQuotaForAProject", "summary": "Reset quota for a project", "description": "Reset quota for a project", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/resetQuotaForAProject" }, "task": true }, { "name": "listDefaultQuotasForAProject", "summary": "List default quotas for a project", "description": "List default quotas for a project", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listDefaultQuotasForAProject" }, "task": true }, { "name": "showQuotaDetailsForATenant", "summary": "Show quota details for a tenant", "description": "Show quota details for a tenant", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showQuotaDetailsForATenant" }, "task": true }, { "name": "listServiceProviders", "summary": "List service providers", "description": "List service providers", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listServiceProviders" }, "task": true }, { "name": "replaceAllTags", "summary": "Replace all tags", "description": "Replace all tags", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"tags\": \"array\"}", "required": false, "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/replaceAllTags" }, "task": true }, { "name": "removeAllTags", "summary": "Remove all tags", "description": "Remove all tags", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeAllTags" }, "task": true }, { "name": "obtainTagList", "summary": "Obtain Tag List", "description": "Obtain Tag List", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/obtainTagList" }, "task": true }, { "name": "confirmATag", "summary": "Confirm a tag", "description": "Confirm a tag", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } }, { "name": "tag", "type": "string", "info": "The name for the tag.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/confirmATag" }, "task": true }, { "name": "addATag", "summary": "Add a tag", "description": "Add a tag", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } }, { "name": "tag", "type": "string", "info": "The name for the tag.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addATag" }, "task": true }, { "name": "removeATag", "summary": "Remove a tag", "description": "Remove a tag", "input": [ { "name": "resourceType", "type": "string", "info": "The type of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "The ID of resource which the tag is set on.: string", "required": true, "schema": { "title": "resourceId", "type": "string" } }, { "name": "tag", "type": "string", "info": "The name for the tag.: string", "required": true, "schema": { "title": "tag", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeATag" }, "task": true }, { "name": "listQoSRuleTypes", "summary": "List QoS rule types", "description": "List QoS rule types", "input": [ { "name": "allSupported", "type": "boolean", "info": "Set to true to return all QoS rule types supported by any loaded driver.: boolean", "required": true, "schema": { "title": "allSupported", "type": "boolean" } }, { "name": "allRules", "type": "boolean", "info": "Set to true to return all QoS rule types implemented in the Neutron server.: boolean", "required": true, "schema": { "title": "allRules", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listQoSRuleTypes" }, "task": true }, { "name": "showQoSRuleTypeDetails", "summary": "Show QoS rule type details", "description": "Show QoS rule type details", "input": [ { "name": "ruleType", "type": "string", "info": "The name of the QoS rule type. It should be one of the types\nreturned by the List QoS rule types API, for example\nbandwidth_limit or dscp_marking.: string", "required": true, "schema": { "title": "ruleType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showQoSRuleTypeDetails" }, "task": true }, { "name": "listQoSPolicies", "summary": "List QoS policies", "description": "List QoS policies", "input": [ { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "shared", "type": "boolean", "info": "Filter the QoS policy list result based on whether this policy is shared\nacross all projects.: boolean", "required": false, "schema": { "title": "shared", "type": "boolean" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "isDefault", "type": "boolean", "info": "Filter the QoS policy list result based on whether this policy is the\ndefault policy.: boolean", "required": false, "schema": { "title": "isDefault", "type": "boolean" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "tags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tags", "type": "string" } }, { "name": "tagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "tagsAny", "type": "string" } }, { "name": "notTags", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTags", "type": "string" } }, { "name": "notTagsAny", "type": "string", "info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string", "required": false, "schema": { "title": "notTagsAny", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a QOS policy attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listQoSPolicies" }, "task": true }, { "name": "createQoSPolicy", "summary": "Create QoS policy", "description": "Create QoS policy", "input": [ { "name": "body", "type": "object", "info": ": {\"policy\": {\"name\": \"string\", \"description\": \"string\", \"shared\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shared": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createQoSPolicy" }, "task": true }, { "name": "showQoSPolicyDetails", "summary": "Show QoS policy details", "description": "Show QoS policy details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showQoSPolicyDetails" }, "task": true }, { "name": "updateQoSPolicy", "summary": "Update QoS policy", "description": "Update QoS policy", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"policy\": {\"name\": \"string\", \"description\": \"string\", \"shared\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "policy": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "shared": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateQoSPolicy" }, "task": true }, { "name": "deleteQoSPolicy", "summary": "Delete QoS policy", "description": "Delete QoS policy", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteQoSPolicy" }, "task": true }, { "name": "listBandwidthLimitRulesForQoSPolicy", "summary": "List bandwidth limit rules for QoS policy", "description": "List bandwidth limit rules for QoS policy", "input": [ { "name": "maxKbps", "type": "number", "info": "Filter the list result by the maximum KBPS (kilobits per second) value.: 123", "required": false, "schema": { "title": "maxKbps", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "maxBurstKbps", "type": "number", "info": "Filter the list result by the maximum burst size (in kilobits).: 123", "required": false, "schema": { "title": "maxBurstKbps", "type": "number" } }, { "name": "direction", "type": "string", "info": "Filter the list result by the direction of the traffic to which the QoS\nrule is applied. Valid values are egress and ingress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a bandwidth limit rule attribute. You can specify multiple pairs\nof sort key and sort direction query parameters. The sort keys are limited\nto:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listBandwidthLimitRulesForQoSPolicy" }, "task": true }, { "name": "createBandwidthLimitRule", "summary": "Create bandwidth limit rule", "description": "Create bandwidth limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bandwidth_limit_rule\": {\"max_kbps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "bandwidth_limit_rule": { "type": "object", "properties": { "max_kbps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createBandwidthLimitRule" }, "task": true }, { "name": "showBandwidthLimitRuleDetails", "summary": "Show bandwidth limit rule details", "description": "Show bandwidth limit rule details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showBandwidthLimitRuleDetails" }, "task": true }, { "name": "updateBandwidthLimitRule", "summary": "Update bandwidth limit rule", "description": "Update bandwidth limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bandwidth_limit_rule\": {\"max_kbps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "bandwidth_limit_rule": { "type": "object", "properties": { "max_kbps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateBandwidthLimitRule" }, "task": true }, { "name": "deleteBandwidthLimitRule", "summary": "Delete bandwidth limit rule", "description": "Delete bandwidth limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteBandwidthLimitRule" }, "task": true }, { "name": "listDSCPMarkingRulesForQoSPolicy", "summary": "List DSCP marking rules for QoS policy", "description": "List DSCP marking rules for QoS policy", "input": [ { "name": "dscpMark", "type": "number", "info": "Filter the list result by the DSCP mark value.: 123", "required": false, "schema": { "title": "dscpMark", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a DSCP marking rule attribute. You can specify multiple pairs of\nsort key and sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listDSCPMarkingRulesForQoSPolicy" }, "task": true }, { "name": "createDSCPMarkingRule", "summary": "Create DSCP marking rule", "description": "Create DSCP marking rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"dscp_marking_rule\": {\"dscp_mark\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "dscp_marking_rule": { "type": "object", "properties": { "dscp_mark": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createDSCPMarkingRule" }, "task": true }, { "name": "showDSCPMarkingRuleDetails", "summary": "Show DSCP marking rule details", "description": "Show DSCP marking rule details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDSCPMarkingRuleDetails" }, "task": true }, { "name": "updateDSCPMarkingRule", "summary": "Update DSCP marking rule", "description": "Update DSCP marking rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"dscp_marking_rule\": {\"dscp_mark\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "dscp_marking_rule": { "type": "object", "properties": { "dscp_mark": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDSCPMarkingRule" }, "task": true }, { "name": "deleteDSCPMarkingRule", "summary": "Delete DSCP marking rule", "description": "Delete DSCP marking rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDSCPMarkingRule" }, "task": true }, { "name": "listMinimumBandwidthRulesForQoSPolicy", "summary": "List minimum bandwidth rules for QoS policy", "description": "List minimum bandwidth rules for QoS policy", "input": [ { "name": "minKbps", "type": "number", "info": "Filter the list result by the minimum KBPS (kilobits per second) value\nwhich should be available for port.: 123", "required": false, "schema": { "title": "minKbps", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "direction", "type": "string", "info": "Filter the list result by the direction of the traffic to which the QoS\nrule is applied. Valid values are egress and ingress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a minimum bandwidth rule attribute. You can specify multiple pairs\nof sort key and sort direction query parameters. The sort keys are limited\nto:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listMinimumBandwidthRulesForQoSPolicy" }, "task": true }, { "name": "createMinimumBandwidthRule", "summary": "Create minimum bandwidth rule", "description": "Create minimum bandwidth rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"minimum_bandwidth_rule\": {\"min_kbps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "minimum_bandwidth_rule": { "type": "object", "properties": { "min_kbps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMinimumBandwidthRule" }, "task": true }, { "name": "showMinimumBandwidthRuleDetails", "summary": "Show minimum bandwidth rule details", "description": "Show minimum bandwidth rule details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMinimumBandwidthRuleDetails" }, "task": true }, { "name": "updateMinimumBandwidthRule", "summary": "Update minimum bandwidth rule", "description": "Update minimum bandwidth rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"minimum_bandwidth_rule\": {\"min_kbps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "minimum_bandwidth_rule": { "type": "object", "properties": { "min_kbps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMinimumBandwidthRule" }, "task": true }, { "name": "deleteMinimumBandwidthRule", "summary": "Delete minimum bandwidth rule", "description": "Delete minimum bandwidth rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMinimumBandwidthRule" }, "task": true }, { "name": "listMinimumPacketRateRulesForQoSPolicy", "summary": "List minimum packet rate rules for QoS policy", "description": "List minimum packet rate rules for QoS policy", "input": [ { "name": "minKpps", "type": "number", "info": "Filter the list result by the min kpps (kilo packets per second) value.: 123", "required": false, "schema": { "title": "minKpps", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "direction", "type": "string", "info": "Filter the list result by the direction of the traffic to which the QoS\nminimum packet rule is applied. Valid values are any, egress and\ningress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a minimum packet rate rule attribute. You can specify multiple\npairs of sort key and sort direction query parameters. The sort keys are\nlimited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listMinimumPacketRateRulesForQoSPolicy" }, "task": true }, { "name": "createMinimumPacketRateRule", "summary": "Create minimum packet rate rule", "description": "Create minimum packet rate rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"minimum_packet_rate_rule\": {\"min_kpps\": 123, \"direction\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "minimum_packet_rate_rule": { "type": "object", "properties": { "min_kpps": { "type": "integer" }, "direction": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createMinimumPacketRateRule" }, "task": true }, { "name": "showMinimumPacketRateRuleDetails", "summary": "Show minimum packet rate rule details", "description": "Show minimum packet rate rule details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMinimumPacketRateRuleDetails" }, "task": true }, { "name": "updateMinimumPacketRateRule", "summary": "Update minimum packet rate rule", "description": "Update minimum packet rate rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"minimum_packet_rate_rule\": {\"min_kpps\": 123, \"direction\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "minimum_packet_rate_rule": { "type": "object", "properties": { "min_kpps": { "type": "integer" }, "direction": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMinimumPacketRateRule" }, "task": true }, { "name": "deleteMinimumPacketRateRule", "summary": "Delete minimum packet rate rule", "description": "Delete minimum packet rate rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMinimumPacketRateRule" }, "task": true }, { "name": "listPacketRateLimitRulesForQoSPolicy", "summary": "List packet rate limit rules for QoS policy", "description": "List packet rate limit rules for QoS policy", "input": [ { "name": "maxKpps", "type": "number", "info": "Filter the list result by the max kpps (kilo packets per second) value.: 123", "required": false, "schema": { "title": "maxKpps", "type": "number" } }, { "name": "maxBurstKpps", "type": "number", "info": "Filter the list result by the max burst kpps (kilo packets per second) value.: 123", "required": false, "schema": { "title": "maxBurstKpps", "type": "number" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "direction", "type": "string", "info": "Filter the list result by the direction of the traffic to which the QoS\nrule is applied. Valid values are egress and ingress.: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a packet rate limit rule attribute. You can specify multiple pairs\nof sort key and sort direction query parameters. The sort keys are limited\nto:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listPacketRateLimitRulesForQoSPolicy" }, "task": true }, { "name": "createPacketRateLimitRule", "summary": "Create packet rate limit rule", "description": "Create packet rate limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"packet_rate_limit_rule\": {\"max_kpps\": \"string\", \"max_burst_kpps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "packet_rate_limit_rule": { "type": "object", "properties": { "max_kpps": { "type": "string" }, "max_burst_kpps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPacketRateLimitRule" }, "task": true }, { "name": "showPacketRateLimitRuleDetails", "summary": "Show packet rate limit rule details", "description": "Show packet rate limit rule details", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPacketRateLimitRuleDetails" }, "task": true }, { "name": "updatePacketRateLimitRule", "summary": "Update packet rate limit rule", "description": "Update packet rate limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"packet_rate_limit_rule\": {\"max_kpps\": \"string\", \"max_burst_kpps\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "packet_rate_limit_rule": { "type": "object", "properties": { "max_kpps": { "type": "string" }, "max_burst_kpps": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePacketRateLimitRule" }, "task": true }, { "name": "deletePacketRateLimitRule", "summary": "Delete packet rate limit rule", "description": "Delete packet rate limit rule", "input": [ { "name": "policyId", "type": "string", "info": "The ID of the QoS policy.: string", "required": true, "schema": { "title": "policyId", "type": "string" } }, { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePacketRateLimitRule" }, "task": true }, { "name": "showBandwidthLimitRuleDetailsAlias", "summary": "Show bandwidth limit rule details alias", "description": "Show bandwidth limit rule details alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showBandwidthLimitRuleDetailsAlias" }, "task": true }, { "name": "updateBandwidthLimitRuleAlias", "summary": "Update bandwidth limit rule alias", "description": "Update bandwidth limit rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateBandwidthLimitRuleAlias" }, "task": true }, { "name": "deleteBandwidthLimitRuleAlias", "summary": "Delete bandwidth limit rule alias", "description": "Delete bandwidth limit rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteBandwidthLimitRuleAlias" }, "task": true }, { "name": "showDSCPMarkingRuleDetailsAlias", "summary": "Show DSCP marking rule details alias", "description": "Show DSCP marking rule details alias", "input": [ { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDSCPMarkingRuleDetailsAlias" }, "task": true }, { "name": "updateDSCPMarkingRuleAlias", "summary": "Update DSCP marking rule alias", "description": "Update DSCP marking rule alias", "input": [ { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateDSCPMarkingRuleAlias" }, "task": true }, { "name": "deleteDSCPMarkingRuleAlias", "summary": "Delete DSCP marking rule alias", "description": "Delete DSCP marking rule alias", "input": [ { "name": "dscpRuleId", "type": "string", "info": "The ID of the DSCP rule.: string", "required": true, "schema": { "title": "dscpRuleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDSCPMarkingRuleAlias" }, "task": true }, { "name": "showMinimumBandwidthRuleDetailsAlias", "summary": "Show minimum bandwidth rule details alias", "description": "Show minimum bandwidth rule details alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMinimumBandwidthRuleDetailsAlias" }, "task": true }, { "name": "updateMinimumBandwidthRuleAlias", "summary": "Update minimum bandwidth rule alias", "description": "Update minimum bandwidth rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMinimumBandwidthRuleAlias" }, "task": true }, { "name": "deleteMinimumBandwidthRuleAlias", "summary": "Delete minimum bandwidth rule alias", "description": "Delete minimum bandwidth rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMinimumBandwidthRuleAlias" }, "task": true }, { "name": "showMinimumPacketRateRuleDetailsAlias", "summary": "Show minimum packet rate rule details alias", "description": "Show minimum packet rate rule details alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMinimumPacketRateRuleDetailsAlias" }, "task": true }, { "name": "updateMinimumPacketRateRuleAlias", "summary": "Update minimum packet rate rule alias", "description": "Update minimum packet rate rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateMinimumPacketRateRuleAlias" }, "task": true }, { "name": "deleteMinimumPacketRateRuleAlias", "summary": "Delete minimum packet rate rule alias", "description": "Delete minimum packet rate rule alias", "input": [ { "name": "ruleId", "type": "string", "info": "The ID of the QoS rule.: string", "required": true, "schema": { "title": "ruleId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMinimumPacketRateRuleAlias" }, "task": true }, { "name": "listLoggingResources", "summary": "List Logging Resources", "description": "List Logging Resources", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listLoggingResources" }, "task": true }, { "name": "createLoggingResource", "summary": "Create Logging Resource", "description": "Create Logging Resource", "input": [ { "name": "body", "type": "object", "info": ": {\"logging_resource\": {\"description\": \"string\", \"enabled\": \"boolean\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "logging_resource": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLoggingResource" }, "task": true }, { "name": "showLoggingResourceDetails", "summary": "Show Logging Resource Details", "description": "Show Logging Resource Details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLoggingResourceDetails" }, "task": true }, { "name": "updateLoggingResource", "summary": "Update Logging Resource", "description": "Update Logging Resource", "input": [ { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"logging_resource\": {\"description\": \"string\", \"enabled\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "logging_resource": { "type": "object", "properties": { "description": { "type": "string" }, "enabled": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateLoggingResource" }, "task": true }, { "name": "deleteLoggingResource", "summary": "Delete Logging Resource", "description": "Delete Logging Resource", "input": [ { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLoggingResource" }, "task": true }, { "name": "listFirewallLogs", "summary": "List Firewall Logs", "description": "List Firewall Logs", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listFirewallLogs" }, "task": true }, { "name": "createFirewallLog", "summary": "Create Firewall Log", "description": "Create Firewall Log", "input": [ { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_log\": {\"description\": \"string\", \"firewall_id\": \"string\", \"fw_event\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_log": { "type": "object", "properties": { "description": { "type": "string" }, "firewall_id": { "type": "string" }, "fw_event": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createFirewallLog" }, "task": true }, { "name": "showFirewallLogDetails", "summary": "Show Firewall Log Details", "description": "Show Firewall Log Details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } }, { "name": "firewallLogId", "type": "string", "info": "The ID of the firewall log resource.: string", "required": true, "schema": { "title": "firewallLogId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showFirewallLogDetails" }, "task": true }, { "name": "updateFirewallLog", "summary": "Update Firewall Log", "description": "Update Firewall Log", "input": [ { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } }, { "name": "firewallLogId", "type": "string", "info": "The ID of the firewall log resource.: string", "required": true, "schema": { "title": "firewallLogId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"firewall_log\": {\"description\": \"string\", \"fw_event\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "firewall_log": { "type": "object", "properties": { "description": { "type": "string" }, "fw_event": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateFirewallLog" }, "task": true }, { "name": "deleteFirewallLog", "summary": "Delete Firewall Log", "description": "Delete Firewall Log", "input": [ { "name": "loggingResourceId", "type": "string", "info": "The ID of the logging resource.: string", "required": true, "schema": { "title": "loggingResourceId", "type": "string" } }, { "name": "firewallLogId", "type": "string", "info": "The ID of the firewall log resource.: string", "required": true, "schema": { "title": "firewallLogId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteFirewallLog" }, "task": true }, { "name": "listBGPVPNs", "summary": "List BGP VPNs", "description": "List BGP VPNs", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listBGPVPNs" }, "task": true }, { "name": "createBGPVPNS", "summary": "Create BGP VPNS", "description": "Create BGP VPNS", "input": [ { "name": "body", "type": "object", "info": ": {\"bgpvpn\": {\"tenant_id\": \"string\", \"route_targets\": \"string\", \"import_targets\": \"string\", \"export_targets\": \"string\", \"route_distinguishers\": \"array\", \"type\": \"string\", \"vni\": 123}}", "required": false, "schema": { "type": "object", "properties": { "bgpvpn": { "type": "object", "properties": { "tenant_id": { "type": "string" }, "route_targets": { "type": "string" }, "import_targets": { "type": "string" }, "export_targets": { "type": "string" }, "route_distinguishers": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "vni": { "type": "integer" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createBGPVPNS" }, "task": true }, { "name": "showBGPVPNDetails", "summary": "Show BGP VPN details", "description": "Show BGP VPN details", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showBGPVPNDetails" }, "task": true }, { "name": "updateABGPVPN", "summary": "Update a BGP VPN", "description": "Update a BGP VPN", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bgpvpn\": {\"name\": \"string\", \"route_targets\": \"array\", \"export_targets\": \"array\", \"import_targets\": \"array\"}}", "required": false, "schema": { "type": "object", "properties": { "bgpvpn": { "type": "object", "properties": { "name": { "type": "string" }, "route_targets": { "type": "array", "items": { "type": "string" } }, "export_targets": { "type": "array", "items": { "items": {} } }, "import_targets": { "type": "array", "items": { "items": {} } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateABGPVPN" }, "task": true }, { "name": "deleteBGPVPN", "summary": "Delete BGP VPN", "description": "Delete BGP VPN", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteBGPVPN" }, "task": true }, { "name": "listNetworkAssociations", "summary": "List Network Associations", "description": "List Network Associations", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNetworkAssociations" }, "task": true }, { "name": "createNetworkAssociation", "summary": "Create Network Association", "description": "Create Network Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"network_association\": {\"network_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "network_association": { "type": "object", "properties": { "network_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createNetworkAssociation" }, "task": true }, { "name": "showNetworkAssociationDetails", "summary": "Show Network Association details", "description": "Show Network Association details", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "networkAssociationId", "type": "string", "info": "The ID of an association between a network and a BGP VPN.: string", "required": true, "schema": { "title": "networkAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworkAssociationDetails" }, "task": true }, { "name": "deleteNetworkAssociation", "summary": "Delete Network Association", "description": "Delete Network Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "networkAssociationId", "type": "string", "info": "The ID of an association between a network and a BGP VPN.: string", "required": true, "schema": { "title": "networkAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkAssociation" }, "task": true }, { "name": "listRouterAssociations", "summary": "List Router Associations", "description": "List Router Associations", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRouterAssociations" }, "task": true }, { "name": "createRouterAssociation", "summary": "Create Router Association", "description": "Create Router Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router_association\": {\"router_id\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "router_association": { "type": "object", "properties": { "router_id": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRouterAssociation" }, "task": true }, { "name": "showRouterAssociationDetails", "summary": "Show Router Association details", "description": "Show Router Association details", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "routerAssociationId", "type": "string", "info": "The ID of an association between a router and a BGP VPN.: string", "required": true, "schema": { "title": "routerAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRouterAssociationDetails" }, "task": true }, { "name": "updateARouterAssociationBgpvpnRoutesControlExtension", "summary": "Update a Router Association (‘bgpvpn-routes-control’ extension)", "description": "Update a Router Association (‘bgpvpn-routes-control’ extension)", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "routerAssociationId", "type": "string", "info": "The ID of an association between a router and a BGP VPN.: string", "required": true, "schema": { "title": "routerAssociationId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router_association\": {\"router_id\": \"string\", \"advertise_extra_routes\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "router_association": { "type": "object", "properties": { "router_id": { "type": "string" }, "advertise_extra_routes": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateARouterAssociationBgpvpnRoutesControlExtension" }, "task": true }, { "name": "deleteRouterAssociation", "summary": "Delete Router Association", "description": "Delete Router Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "routerAssociationId", "type": "string", "info": "The ID of an association between a router and a BGP VPN.: string", "required": true, "schema": { "title": "routerAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRouterAssociation" }, "task": true }, { "name": "listPortAssociations", "summary": "List Port Associations", "description": "List Port Associations", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listPortAssociations" }, "task": true }, { "name": "createPortAssociation", "summary": "Create Port Association", "description": "Create Port Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port_association\": {\"port_id\": \"string\", \"routes\": [{\"type\": \"string\", \"prefix\": \"string\"}]}}", "required": false, "schema": { "type": "object", "properties": { "port_association": { "type": "object", "properties": { "port_id": { "type": "string" }, "routes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "prefix": { "type": "string" } } } } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPortAssociation" }, "task": true }, { "name": "showPortAssociationDetails", "summary": "Show Port Association details", "description": "Show Port Association details", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "portAssociationId", "type": "string", "info": "The ID of an association between a port and a BGP VPN.: string", "required": true, "schema": { "title": "portAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPortAssociationDetails" }, "task": true }, { "name": "updateAPortAssociation", "summary": "Update a Port Association", "description": "Update a Port Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "portAssociationId", "type": "string", "info": "The ID of an association between a port and a BGP VPN.: string", "required": true, "schema": { "title": "portAssociationId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"port_association\": {\"port_id\": \"string\", \"routes\": [{\"type\": \"string\", \"bgpvpn_id\": \"string\", \"local_pref\": 123}], \"advertise_fixed_ips\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "port_association": { "type": "object", "properties": { "port_id": { "type": "string" }, "routes": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "bgpvpn_id": { "type": "string" }, "local_pref": { "type": "integer" } } } }, "advertise_fixed_ips": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAPortAssociation" }, "task": true }, { "name": "deletePortAssociation", "summary": "Delete Port Association", "description": "Delete Port Association", "input": [ { "name": "bgpvpnId", "type": "string", "info": "The ID of the BGP VPN.: string", "required": true, "schema": { "title": "bgpvpnId", "type": "string" } }, { "name": "portAssociationId", "type": "string", "info": "The ID of an association between a port and a BGP VPN.: string", "required": true, "schema": { "title": "portAssociationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePortAssociation" }, "task": true }, { "name": "listBGPSpeakers", "summary": "List BGP Speakers", "description": "List BGP Speakers", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listBGPSpeakers" }, "task": true }, { "name": "createBGPSpeaker", "summary": "Create BGP Speaker", "description": "Create BGP Speaker", "input": [ { "name": "body", "type": "object", "info": ": {\"bgp_speaker\": {\"ip_version\": 123, \"local_as\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "bgp_speaker": { "type": "object", "properties": { "ip_version": { "type": "integer" }, "local_as": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createBGPSpeaker" }, "task": true }, { "name": "showBGPSpeakerDetails", "summary": "Show BGP Speaker details", "description": "Show BGP Speaker details", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showBGPSpeakerDetails" }, "task": true }, { "name": "updateABGPSpeaker", "summary": "Update a BGP Speaker", "description": "Update a BGP Speaker", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bgp_speaker\": {\"advertise_floating_ip_host_routes\": \"string\", \"advertise_tenant_networks\": \"string\", \"name\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "bgp_speaker": { "type": "object", "properties": { "advertise_floating_ip_host_routes": { "type": "string" }, "advertise_tenant_networks": { "type": "string" }, "name": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateABGPSpeaker" }, "task": true }, { "name": "deleteABGPSpeaker", "summary": "Delete a BGP Speaker", "description": "Delete a BGP Speaker", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteABGPSpeaker" }, "task": true }, { "name": "addBGPPeerToABGPSpeaker", "summary": "Add BGP Peer to a BGP Speaker", "description": "Add BGP Peer to a BGP Speaker", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bgp_peer_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "bgp_peer_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addBGPPeerToABGPSpeaker" }, "task": true }, { "name": "removeBGPPeerFromABGPSpeaker", "summary": "Remove BGP Peer from a BGP Speaker", "description": "Remove BGP Peer from a BGP Speaker", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"bgp_peer_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "bgp_peer_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeBGPPeerFromABGPSpeaker" }, "task": true }, { "name": "addNetworkToABGPSpeaker", "summary": "Add Network to a BGP Speaker", "description": "Add Network to a BGP Speaker", "input": [ { "name": "bgpSpeakerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpSpeakerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"network_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "network_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNetworkToABGPSpeaker" }, "task": true }, { "name": "deleteNetworkFromABGPSpeaker", "summary": "Delete Network from a BGP Speaker", "description": "Delete Network from a BGP Speaker", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteNetworkFromABGPSpeaker" }, "task": true }, { "name": "listRoutesAdvertisedByABGPSpeaker", "summary": "List routes advertised by a BGP Speaker", "description": "List routes advertised by a BGP Speaker", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listRoutesAdvertisedByABGPSpeaker" }, "task": true }, { "name": "listDynamicRoutingAgentsHostingASpecificBGPSpeaker", "summary": "List Dynamic Routing Agents hosting a specific BGP Speaker", "description": "List Dynamic Routing Agents hosting a specific BGP Speaker", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listDynamicRoutingAgentsHostingASpecificBGPSpeaker" }, "task": true }, { "name": "listBGPPeers", "summary": "List BGP Peers", "description": "List BGP Peers", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listBGPPeers" }, "task": true }, { "name": "createABGPPeer", "summary": "Create a BGP Peer", "description": "Create a BGP Peer", "input": [ { "name": "body", "type": "object", "info": ": {\"bgp_peer\": {\"auth_type\": \"string\", \"remote_as\": \"string\", \"name\": \"string\", \"peer_ip\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "bgp_peer": { "type": "object", "properties": { "auth_type": { "type": "string" }, "remote_as": { "type": "string" }, "name": { "type": "string" }, "peer_ip": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createABGPPeer" }, "task": true }, { "name": "showBGPPeerDetails", "summary": "Show BGP Peer details", "description": "Show BGP Peer details", "input": [ { "name": "bgpPeerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpPeerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showBGPPeerDetails" }, "task": true }, { "name": "updateABGPPeer", "summary": "Update a BGP Peer", "description": "Update a BGP Peer", "input": [ { "name": "bgpPeerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpPeerId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"password\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "password": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateABGPPeer" }, "task": true }, { "name": "deleteABGPPeer", "summary": "Delete a BGP Peer", "description": "Delete a BGP Peer", "input": [ { "name": "bgpPeerId", "type": "string", "info": "The ID of the BGP Speaker.: string", "required": true, "schema": { "title": "bgpPeerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteABGPPeer" }, "task": true }, { "name": "listLogs", "summary": "List logs", "description": "List logs", "input": [ { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "event", "type": "string", "info": "Filter the log list result by the type of security events,\nwhich is ACCEPT, DROP, or ALL.: string", "required": false, "schema": { "title": "event", "type": "string" } }, { "name": "revisionNumber", "type": "number", "info": "Filter the list result by the revision number of the resource.: 123", "required": false, "schema": { "title": "revisionNumber", "type": "number" } }, { "name": "resourceType", "type": "string", "info": "Filter the log list result by the resource type such as security_group.: string", "required": false, "schema": { "title": "resourceType", "type": "string" } }, { "name": "resourceId", "type": "string", "info": "Filter the log list result by the ID of resource (e.g security group ID).: string", "required": false, "schema": { "title": "resourceId", "type": "string" } }, { "name": "targetId", "type": "string", "info": "Filter the log list result by the ID of resource that is the\nlogging target.: string", "required": false, "schema": { "title": "targetId", "type": "string" } }, { "name": "enabled", "type": "boolean", "info": "Filter the log list result based on this log object is enabled (true)\nor disabled (false).: boolean", "required": false, "schema": { "title": "enabled", "type": "boolean" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by a log attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listLogs" }, "task": true }, { "name": "createLog", "summary": "Create log", "description": "Create log", "input": [ { "name": "body", "type": "object", "info": ": {\"log\": {\"name\": \"string\", \"description\": \"string\", \"resource_type\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "log": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "resource_type": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createLog" }, "task": true }, { "name": "showLog", "summary": "Show log", "description": "Show log", "input": [ { "name": "logId", "type": "string", "info": "The ID of the log resource.: string", "required": true, "schema": { "title": "logId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLog" }, "task": true }, { "name": "updateLog", "summary": "Update log", "description": "Update log", "input": [ { "name": "logId", "type": "string", "info": "The ID of the log resource.: string", "required": true, "schema": { "title": "logId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"log\": {\"enabled\": \"boolean\"}}", "required": false, "schema": { "type": "object", "properties": { "log": { "type": "object", "properties": { "enabled": { "type": "boolean" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateLog" }, "task": true }, { "name": "deleteLog", "summary": "Delete log", "description": "Delete log", "input": [ { "name": "logId", "type": "string", "info": "The ID of the log resource.: string", "required": true, "schema": { "title": "logId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteLog" }, "task": true }, { "name": "listLoggableResources", "summary": "List loggable resources", "description": "List loggable resources", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listLoggableResources" }, "task": true }, { "name": "listAllAgents", "summary": "List all agents", "description": "List all agents", "input": [ { "name": "adminStateUp", "type": "boolean", "info": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).: boolean", "required": false, "schema": { "title": "adminStateUp", "type": "boolean" } }, { "name": "agentType", "type": "string", "info": "Filter the list result by the type of agent such as Open vSwitch agent\nor DHCP agent.: string", "required": false, "schema": { "title": "agentType", "type": "string" } }, { "name": "alive", "type": "boolean", "info": "Filter the list result based on whether the agent is alive and running.: boolean", "required": false, "schema": { "title": "alive", "type": "boolean" } }, { "name": "availabilityZone", "type": "string", "info": "Filter the list result by the availability zone of the agent.: string", "required": false, "schema": { "title": "availabilityZone", "type": "string" } }, { "name": "binary", "type": "string", "info": "Filter the list result by the executable command used to start the agent\nsuch as neutron-openvswitch-agent or neutron-dhcp-agent.: string", "required": false, "schema": { "title": "binary", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } }, { "name": "host", "type": "string", "info": "Filter the list result by the hostname of the system the agent is running\non.: string", "required": false, "schema": { "title": "host", "type": "string" } }, { "name": "id", "type": "string", "info": "Filter the list result by the ID of the resource.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "topic", "type": "string", "info": "Filter the list result by the name of AMQP topic the agent is listening on\nsuch as dhcp_agent.: string", "required": false, "schema": { "title": "topic", "type": "string" } }, { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "sortDir", "type": "string", "info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string", "required": false, "schema": { "title": "sortDir", "type": "string" } }, { "name": "sortKey", "type": "string", "info": "Sorts by agent attributes. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string", "required": false, "schema": { "title": "sortKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAllAgents" }, "task": true }, { "name": "showAgentDetails", "summary": "Show agent details", "description": "Show agent details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAgentDetails" }, "task": true }, { "name": "updateAgent", "summary": "Update agent", "description": "Update agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"agent\": {\"description\": \"string\"}}", "required": false, "schema": { "type": "object", "properties": { "agent": { "type": "object", "properties": { "description": { "type": "string" } } } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateAgent" }, "task": true }, { "name": "deleteAgent", "summary": "Delete agent", "description": "Delete agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAgent" }, "task": true }, { "name": "listAllAvailabilityZones", "summary": "List all availability zones", "description": "List all availability zones", "input": [ { "name": "state", "type": "string", "info": "Filter the list result by the state of the availability zone, which is\neither available or unavailable.: string", "required": false, "schema": { "title": "state", "type": "string" } }, { "name": "resource", "type": "string", "info": "Filter the list result by the resource type of the availability zone.\nThe supported resource types are network and router.: string", "required": false, "schema": { "title": "resource", "type": "string" } }, { "name": "name", "type": "string", "info": "Filter the list result by the human-readable name of the resource.: string", "required": false, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listAllAvailabilityZones" }, "task": true }, { "name": "listRoutersHostedByAnL3Agent", "summary": "List routers hosted by an L3 agent", "description": "List routers hosted by an L3 agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listRoutersHostedByAnL3Agent" }, "task": true }, { "name": "scheduleRouterToAnL3Agent", "summary": "Schedule router to an l3 agent", "description": "Schedule router to an l3 agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"router_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "router_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/scheduleRouterToAnL3Agent" }, "task": true }, { "name": "removeL3RouterFromAnL3Agent", "summary": "Remove l3 router from an l3 agent", "description": "Remove l3 router from an l3 agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeL3RouterFromAnL3Agent" }, "task": true }, { "name": "listL3AgentsHostingARouter", "summary": "List L3 agents hosting a router", "description": "List L3 agents hosting a router", "input": [ { "name": "routerId", "type": "string", "info": "The ID of the router.: string", "required": true, "schema": { "title": "routerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listL3AgentsHostingARouter" }, "task": true }, { "name": "listNetworksHostedByADHCPAgent", "summary": "List networks hosted by a DHCP agent", "description": "List networks hosted by a DHCP agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listNetworksHostedByADHCPAgent" }, "task": true }, { "name": "scheduleANetworkToADHCPAgent", "summary": "Schedule a network to a DHCP agent", "description": "Schedule a network to a DHCP agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"network_id\": \"string\"}", "required": false, "schema": { "type": "object", "properties": { "network_id": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/scheduleANetworkToADHCPAgent" }, "task": true }, { "name": "removeNetworkFromADHCPAgent", "summary": "Remove network from a DHCP agent", "description": "Remove network from a DHCP agent", "input": [ { "name": "agentId", "type": "string", "info": "The ID of the agent.: string", "required": true, "schema": { "title": "agentId", "type": "string" } }, { "name": "networkId", "type": "string", "info": "The ID of the attached network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/removeNetworkFromADHCPAgent" }, "task": true }, { "name": "listDHCPAgentsHostingANetwork", "summary": "List DHCP agents hosting a network", "description": "List DHCP agents hosting a network", "input": [ { "name": "networkId", "type": "string", "info": "The ID of the attached network.: string", "required": true, "schema": { "title": "networkId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listDHCPAgentsHostingANetwork" }, "task": true }, { "name": "showAutoAllocatedTopologyDetails", "summary": "Show auto allocated topology details", "description": "Show auto allocated topology details", "input": [ { "name": "fields", "type": "string", "info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string", "required": false, "schema": { "title": "fields", "type": "string" } }, { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAutoAllocatedTopologyDetails" }, "task": true }, { "name": "deleteTheAutoAllocatedTopology", "summary": "Delete the auto allocated topology", "description": "Delete the auto allocated topology", "input": [ { "name": "projectId", "type": "string", "info": "The ID of the project.: string", "required": true, "schema": { "title": "projectId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTheAutoAllocatedTopology" }, "task": true }, { "name": "listTapServices", "summary": "List Tap Services", "description": "List Tap Services", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listTapServices" }, "task": true }, { "name": "createTapService", "summary": "Create Tap Service", "description": "Create Tap Service", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the Tap Service.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "port", "type": "string", "info": "Port to which the Tap service is connected.: string", "required": false, "schema": { "title": "port", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTapService" }, "task": true }, { "name": "updateTapService", "summary": "Update Tap Service", "description": "Update Tap Service", "input": [ { "name": "name", "type": "string", "info": "The name of the Tap Service.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTapService" }, "task": true }, { "name": "deleteTapService", "summary": "Delete Tap Service", "description": "Delete Tap Service", "input": [ { "name": "name", "type": "string", "info": "The name of the Tap Service.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "id", "type": "string", "info": "The ID of the Tap Service.: string", "required": false, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTapService" }, "task": true }, { "name": "showTapService", "summary": "Show Tap Service", "description": "Show Tap Service", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the Tap Service.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTapService" }, "task": true }, { "name": "listTapFlow", "summary": "List Tap Flow", "description": "List Tap Flow", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listTapFlow" }, "task": true }, { "name": "createTapFlow", "summary": "Create Tap Flow", "description": "Create Tap Flow", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the Tap flow.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "port", "type": "string", "info": "Source port to which the Tap Flow is connected.: string", "required": false, "schema": { "title": "port", "type": "string" } }, { "name": "tapService", "type": "string", "info": "Tap Service to which the Tap Flow belongs.: string", "required": false, "schema": { "title": "tapService", "type": "string" } }, { "name": "vlanFilter", "type": "string", "info": "VLAN Ids to be mirrored in the form of range string.: string", "required": false, "schema": { "title": "vlanFilter", "type": "string" } }, { "name": "direction", "type": "string", "info": "Direction of the Tap flow. Possible options are: IN, OUT, BOTH: string", "required": false, "schema": { "title": "direction", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTapFlow" }, "task": true }, { "name": "updateTapFlow", "summary": "Update Tap Flow", "description": "Update Tap Flow", "input": [ { "name": "name", "type": "string", "info": "The name of the Tap flow.: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "description", "type": "string", "info": "Filter the list result by the human-readable description of the resource.: string", "required": false, "schema": { "title": "description", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateTapFlow" }, "task": true }, { "name": "deleteTapFlow", "summary": "Delete Tap Flow", "description": "Delete Tap Flow", "input": [ { "name": "id", "type": "string", "info": "The ID of the Tap flow.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the Tap flow.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTapFlow" }, "task": true }, { "name": "showTapFlow", "summary": "Show Tap Flow", "description": "Show Tap Flow", "input": [ { "name": "project", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "projectDomain", "type": "string", "info": "Domain the project belongs to (name or ID).\nThis can be used in case collisions between project names exist.: string", "required": false, "schema": { "title": "projectDomain", "type": "string" } }, { "name": "tenantId", "type": "string", "info": "Filter the list result by the ID of the project that owns the resource.: string", "required": false, "schema": { "title": "tenantId", "type": "string" } }, { "name": "id", "type": "string", "info": "The ID of the Tap flow.: string", "required": false, "schema": { "title": "id", "type": "string" } }, { "name": "name", "type": "string", "info": "The name of the Tap flow.: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTapFlow" }, "task": true } ], "views": [] }