{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Openstack Nova API" }, "servers": [ { "url": "http://{host}:{port}", "description": "Compute service (nova) administrative endpoint", "variables": { "host": { "default": "localhost" }, "port": { "default": "8774" } } } ], "paths": { "/": { "get": { "operationId": "listAllMajorVersions", "summary": "List All Major Versions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-all-major-versions" }, "responses": { "200": { "description": "Request was successful." } } } }, "/{api_version}/": { "get": { "operationId": "showDetailsOfSpecificAPIVersion", "summary": "Show Details of Specific API Version", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-details-of-specific-api-version" }, "parameters": [ { "name": "api_version", "in": "path", "required": true, "schema": { "type": "string", "description": "The API version as returned in the links from the GET / call." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers": { "get": { "operationId": "listServers", "summary": "List Servers", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-servers" }, "parameters": [ { "name": "access_ip_v4", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter server list result by IPv4 address that should be used to access the server." } }, { "name": "access_ip_v6", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter server list result by IPv6 address that should be used to access the server." } }, { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Specify the all_tenants query parameter to list all instances for all projects. By default this is only allowed by administrators. If this parameter is specified without a value, the value defaults to True. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False. (They are case-insensitive.)" } }, { "name": "auto_disk_config", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the disk_config setting of the server, Valid values are:" } }, { "name": "availability_zone", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by server availability zone." } }, { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the server last changed status. To help keep track of changes this may also return recently deleted servers." } }, { "name": "config_drive", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the config drive setting of the server." } }, { "name": "created_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when server was created." } }, { "name": "deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Show deleted items only. In some circumstances deleted items will still be accessible via the backend database, however there is no contract on how long, so this parameter should be used with caution. 1, t, true, on, y and yes are treated as True (case-insensitive). Other than them are treated as False." } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by description." } }, { "name": "flavor", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a flavor, as a UUID. A flavor is a combination of memory, disk size, and CPUs." } }, { "name": "host", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the host name of compute node." } }, { "name": "hostname", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the host name of server." } }, { "name": "image", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image, as a UUID." } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string", "description": "An IPv4 address to filter results by." } }, { "name": "ip6", "in": "query", "required": false, "schema": { "type": "string", "description": "An IPv6 address to filter results by." } }, { "name": "kernel_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the kernel image when using an AMI." } }, { "name": "key_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by keypair name." } }, { "name": "launch_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by the sequence in which the servers were launched." } }, { "name": "launched_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when the instance was launched. The date and time stamp format is ISO 8601:" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "locked_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by who locked the server, possible value could be admin or owner." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server name, as a string. You can use regular expressions in the query. For example, the ?name=bob regular expression returns both bob and bobb. If you must match on only bob, you can use a regular expression that matches the syntax of the underlying database server that is implemented for Compute, such as MySQL or PostgreSQL." } }, { "name": "node", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the node." } }, { "name": "power_state", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by server power state." } }, { "name": "progress", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by the progress of the server. The value could be from 0 to 100 as integer." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list of servers by the given project ID." } }, { "name": "ramdisk_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the ramdisk image when using an AMI." } }, { "name": "reservation_id", "in": "query", "required": false, "schema": { "type": "string", "description": "A reservation id as returned by a servers multiple create call." } }, { "name": "root_device_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the root device name of the server." } }, { "name": "soft_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the server list by SOFT_DELETED status. This parameter is only valid when the deleted=True filter parameter is specified." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc (descending). Default is desc. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server sort_key attribute." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a server attribute. Default attribute is created_at. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server sort_key attribute. The sort keys are limited to:" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server status, as a string. For example, ACTIVE." } }, { "name": "task_state", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by task state." } }, { "name": "terminated_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when instance was terminated. The date and time stamp format is ISO 8601:" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list of servers by the given user ID." } }, { "name": "uuid", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the server." } }, { "name": "vm_state", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by vm state." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that don’t match all tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 AND t2)’. Tags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that don’t match any tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 OR t2)’. Tags in query must be separated by comma." } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that match all tags in this list will be returned. Boolean expression in this case is ‘t1 AND t2’. Tags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that match any tag in this list will be returned. Boolean expression in this case is ‘t1 OR t2’. Tags in query must be separated by comma." } }, { "name": "changes-before", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the server last changed. Those servers that changed before or equal to the specified date and time stamp are returned. To help keep track of changes this may also return recently deleted servers." } }, { "name": "locked", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Specify the locked query parameter to list all locked or unlocked instances. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False. (They are case-insensitive.) Any other value provided will be considered invalid." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createServer", "summary": "Create Server", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-server" }, "requestBody": { "content": { "application/json": { "schema": {} } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/detail": { "get": { "operationId": "listServersDetailed", "summary": "List Servers Detailed", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-servers-detailed" }, "parameters": [ { "name": "access_ip_v4", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter server list result by IPv4 address that should be used to access the server." } }, { "name": "access_ip_v6", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter server list result by IPv6 address that should be used to access the server." } }, { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Specify the all_tenants query parameter to list all instances for all projects. By default this is only allowed by administrators. If this parameter is specified without a value, the value defaults to True. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False. (They are case-insensitive.)" } }, { "name": "auto_disk_config", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the disk_config setting of the server, Valid values are:" } }, { "name": "availability_zone", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by server availability zone." } }, { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the server last changed status. To help keep track of changes this may also return recently deleted servers." } }, { "name": "config_drive", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the config drive setting of the server." } }, { "name": "created_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when server was created." } }, { "name": "deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Show deleted items only. In some circumstances deleted items will still be accessible via the backend database, however there is no contract on how long, so this parameter should be used with caution. 1, t, true, on, y and yes are treated as True (case-insensitive). Other than them are treated as False." } }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by description." } }, { "name": "flavor", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a flavor, as a UUID. A flavor is a combination of memory, disk size, and CPUs." } }, { "name": "host", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the host name of compute node." } }, { "name": "hostname", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the host name of server." } }, { "name": "image", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image, as a UUID." } }, { "name": "ip", "in": "query", "required": false, "schema": { "type": "string", "description": "An IPv4 address to filter results by." } }, { "name": "ip6", "in": "query", "required": false, "schema": { "type": "string", "description": "An IPv6 address to filter results by." } }, { "name": "kernel_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the kernel image when using an AMI." } }, { "name": "key_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by keypair name." } }, { "name": "launch_index", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by the sequence in which the servers were launched." } }, { "name": "launched_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when the instance was launched. The date and time stamp format is ISO 8601:" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "locked_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by who locked the server, possible value could be admin or owner." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server name, as a string. You can use regular expressions in the query. For example, the ?name=bob regular expression returns both bob and bobb. If you must match on only bob, you can use a regular expression that matches the syntax of the underlying database server that is implemented for Compute, such as MySQL or PostgreSQL." } }, { "name": "node", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the node." } }, { "name": "power_state", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by server power state." } }, { "name": "progress", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filter the server list result by the progress of the server. The value could be from 0 to 100 as integer." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list of servers by the given project ID." } }, { "name": "ramdisk_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the ramdisk image when using an AMI." } }, { "name": "reservation_id", "in": "query", "required": false, "schema": { "type": "string", "description": "A reservation id as returned by a servers multiple create call." } }, { "name": "root_device_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the root device name of the server." } }, { "name": "soft_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter the server list by SOFT_DELETED status. This parameter is only valid when the deleted=True filter parameter is specified." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc (descending). Default is desc. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server sort_key attribute." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a server attribute. Default attribute is created_at. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server sort_key attribute. The sort keys are limited to:" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server status, as a string. For example, ACTIVE." } }, { "name": "task_state", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by task state." } }, { "name": "terminated_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by a date and time stamp when instance was terminated. The date and time stamp format is ISO 8601:" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the list of servers by the given user ID." } }, { "name": "uuid", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by the UUID of the server." } }, { "name": "vm_state", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the server list result by vm state." } }, { "name": "not-tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that don’t match all tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 AND t2)’. Tags in query must be separated by comma." } }, { "name": "not-tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that don’t match any tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 OR t2)’. Tags in query must be separated by comma." } }, { "name": "tags", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that match all tags in this list will be returned. Boolean expression in this case is ‘t1 AND t2’. Tags in query must be separated by comma." } }, { "name": "tags-any", "in": "query", "required": false, "schema": { "type": "string", "description": "A list of tags to filter the server list by. Servers that match any tag in this list will be returned. Boolean expression in this case is ‘t1 OR t2’. Tags in query must be separated by comma." } }, { "name": "changes-before", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the server last changed. Those servers that changed before or equal to the specified date and time stamp are returned. To help keep track of changes this may also return recently deleted servers." } }, { "name": "locked", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Specify the locked query parameter to list all locked or unlocked instances. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False. (They are case-insensitive.) Any other value provided will be considered invalid." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}": { "get": { "operationId": "showServerDetails", "summary": "Show Server Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateServer", "summary": "Update Server", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-server" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "server": { "type": "object", "properties": { "accessIPv4": { "type": "string", "format": "ip-address" }, "accessIPv6": { "type": "string", "format": "ipv6" }, "OS-DCF:diskConfig": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteServer", "summary": "Delete Server", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-server" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/action": { "post": { "operationId": "add(Associate)FloatingIp(addFloatingIpAction)(DEPRECATED)", "summary": "Add (Associate) Floating Ip (addFloatingIp Action) (DEPRECATED)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#add-associate-floating-ip-addfloatingip-action-deprecated" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addFloatingIp": { "type": "object", "properties": { "address": { "type": "string", "format": "ip-address" }, "fixed_address": { "type": "string", "format": "ip-address" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/remote-consoles": { "post": { "operationId": "createConsole", "summary": "Create Console", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-console" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "remote_console": { "type": "object", "properties": { "protocol": { "type": "string" }, "type": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-console-auth-tokens/{console_token}": { "get": { "operationId": "showConsoleConnectionInformation", "summary": "Show Console Connection Information", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-console-connection-information" }, "parameters": [ { "name": "console_token", "in": "path", "required": true, "schema": { "type": "string", "description": "Console authentication token." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-security-groups": { "get": { "operationId": "listSecurityGroupsByServer", "summary": "List Security Groups By Server", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-security-groups-by-server" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/diagnostics": { "get": { "operationId": "showServerDiagnostics", "summary": "Show Server Diagnostics", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-diagnostics" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/ips": { "get": { "operationId": "listIps", "summary": "List Ips", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-ips" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/ips/{network_label}": { "get": { "operationId": "showIpDetails", "summary": "Show Ip Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-ip-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "network_label", "in": "path", "required": true, "schema": { "type": "string", "description": "The network label, such as public or private." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/metadata": { "get": { "operationId": "listAllMetadata", "summary": "List All Metadata", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-all-metadata" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createOrUpdateMetadataItems", "summary": "Create or Update Metadata Items", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-metadata-items" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "foo": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "replaceMetadataItems", "summary": "Replace Metadata Items", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#replace-metadata-items" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "foo": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/metadata/{key}": { "get": { "operationId": "showMetadataItemDetails", "summary": "Show Metadata Item Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-metadata-item-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "createOrUpdateMetadataItem", "summary": "Create Or Update Metadata Item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-metadata-item" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteMetadataItem", "summary": "Delete Metadata Item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-metadata-item" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-instance-actions": { "get": { "operationId": "listActionsForServer", "summary": "List Actions For Server", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-actions-for-server" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The request_id of the last-seen instance action. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the instance action last changed." } }, { "name": "changes-before", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the instance actions last changed. Those instances that changed before or equal to the specified date and time stamp are returned." } }, { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-instance-actions/{request_id}": { "get": { "operationId": "showServerActionDetails", "summary": "Show Server Action Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-action-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "request_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the request." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-interface": { "get": { "operationId": "listPortInterfaces", "summary": "List Port Interfaces", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-port-interfaces" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createInterface", "summary": "Create Interface", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-interface" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "interfaceAttachment": { "type": "object", "properties": { "fixed_ips": { "type": "array", "items": { "type": "object", "properties": { "ip_address": { "type": "string", "format": "ip-address" } } } }, "net_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-interface/{port_id}": { "get": { "operationId": "showPortInterfaceDetails", "summary": "Show Port Interface Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-port-interface-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "port_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the port." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "detachInterface", "summary": "Detach Interface", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#detach-interface" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "port_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the port." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-server-password": { "get": { "operationId": "showServerPassword", "summary": "Show Server Password", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-password" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "clearAdminPassword", "summary": "Clear Admin Password", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#clear-admin-password" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-volume_attachments": { "get": { "operationId": "listVolumeAttachmentsForAnInstance", "summary": "List volume attachments for an instance", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-volume-attachments-for-an-instance" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } }, { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "attachAVolumeToAnInstance", "summary": "Attach a volume to an instance", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#attach-a-volume-to-an-instance" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volumeAttachment": { "type": "object", "properties": { "volumeId": { "type": "string" }, "device": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-volume_attachments/{volume_id}": { "get": { "operationId": "showADetailOfAVolumeAttachment", "summary": "Show a detail of a volume attachment", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-a-detail-of-a-volume-attachment" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the attached volume." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateAVolumeAttachment", "summary": "Update a volume attachment", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-a-volume-attachment" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the volume being replaced." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volumeAttachment": { "type": "object", "properties": { "volumeId": { "type": "string" }, "delete_on_termination": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "detachAVolumeFromAnInstance", "summary": "Detach a volume from an instance", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#detach-a-volume-from-an-instance" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the volume to detach." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/flavors": { "get": { "operationId": "listFlavors", "summary": "List Flavors", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-flavors" }, "parameters": [ { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a flavor attribute. Default attribute is flavorid. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the flavor sort_key attribute. The sort keys are limited to:" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc (descending). Default is asc. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the flavor sort_key attribute." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "minDisk", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum disk space, in GiB. For example, 100." } }, { "name": "minRam", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum RAM, in MiB. For example, 512." } }, { "name": "is_public", "in": "query", "required": false, "schema": { "type": "string", "description": "This parameter is only applicable to users with the administrative role. For all other non-admin users, the parameter is ignored and only public flavors will be returned. Filters the flavor list based on whether the flavor is public or private. If the value of this parameter is not specified, it is treated as True. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False (they are case-insensitive). If the value is None (case-insensitive) both public and private flavors will be listed in a single request." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createFlavor", "summary": "Create Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-flavor" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flavor": { "type": "object", "properties": { "name": { "type": "string" }, "ram": { "type": "integer" }, "vcpus": { "type": "integer" }, "disk": { "type": "integer" }, "id": { "type": "string", "format": "utc-millisec" }, "rxtx_factor": { "type": "integer" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/detail": { "get": { "operationId": "listFlavorsWithDetails", "summary": "List Flavors With Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-flavors-with-details" }, "parameters": [ { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts by a flavor attribute. Default attribute is flavorid. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the flavor sort_key attribute. The sort keys are limited to:" } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sort direction. A valid value is asc (ascending) or desc (descending). Default is asc. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the flavor sort_key attribute." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "minDisk", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum disk space, in GiB. For example, 100." } }, { "name": "minRam", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum RAM, in MiB. For example, 512." } }, { "name": "is_public", "in": "query", "required": false, "schema": { "type": "string", "description": "This parameter is only applicable to users with the administrative role. For all other non-admin users, the parameter is ignored and only public flavors will be returned. Filters the flavor list based on whether the flavor is public or private. If the value of this parameter is not specified, it is treated as True. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n and no are treated as False (they are case-insensitive). If the value is None (case-insensitive) both public and private flavors will be listed in a single request." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/{flavor_id}": { "get": { "operationId": "showFlavorDetails", "summary": "Show Flavor Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-flavor-details" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateFlavorDescription", "summary": "Update Flavor Description", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-flavor-description" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "flavor": { "type": "object", "properties": { "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteFlavor", "summary": "Delete Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/{flavor_id}/os-flavor-access": { "get": { "operationId": "listFlavorAccessInformationForGivenFlavor", "summary": "List Flavor Access Information For Given Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-flavor-access-information-for-given-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/{flavor_id}/action": { "post": { "operationId": "addFlavorAccessToTenant(addTenantAccessAction)", "summary": "Add Flavor Access To Tenant (addTenantAccess Action)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#add-flavor-access-to-tenant-addtenantaccess-action" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addTenantAccess": { "type": "object", "properties": { "tenant": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/{flavor_id}/os-extra_specs": { "get": { "operationId": "listExtraSpecsForAFlavor", "summary": "List Extra Specs For A Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-extra-specs-for-a-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createExtraSpecsForAFlavor", "summary": "Create Extra Specs For A Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-extra-specs-for-a-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "extra_specs": { "type": "object", "properties": { "hw:cpu_policy": { "type": "string" }, "hw:numa_nodes": { "type": "string", "format": "utc-millisec" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key}": { "get": { "operationId": "showAnExtraSpecForAFlavor", "summary": "Show An Extra Spec For A Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-an-extra-spec-for-a-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } }, { "name": "flavor_extra_spec_key", "in": "path", "required": true, "schema": { "type": "string", "description": "The extra spec key for the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateAnExtraSpecForAFlavor", "summary": "Update An Extra Spec For A Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-an-extra-spec-for-a-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } }, { "name": "flavor_extra_spec_key", "in": "path", "required": true, "schema": { "type": "string", "description": "The extra spec key for the flavor." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hw:numa_nodes": { "type": "string", "format": "utc-millisec" } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteAnExtraSpecForAFlavor", "summary": "Delete An Extra Spec For A Flavor", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-an-extra-spec-for-a-flavor" }, "parameters": [ { "name": "flavor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the flavor." } }, { "name": "flavor_extra_spec_key", "in": "path", "required": true, "schema": { "type": "string", "description": "The extra spec key for the flavor." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-keypairs": { "get": { "operationId": "listKeypairs", "summary": "List Keypairs", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-keypairs" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "This allows administrative users to operate key-pairs of specified user ID." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The last-seen item. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createOrImportKeypair", "summary": "Create Or Import Keypair", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-import-keypair" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keypair": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "public_key": { "type": "string" }, "user_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-keypairs/{keypair_name}": { "get": { "operationId": "showKeypairDetails", "summary": "Show Keypair Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-keypair-details" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "This allows administrative users to operate key-pairs of specified user ID." } }, { "name": "keypair_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The keypair name." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteKeypair", "summary": "Delete Keypair", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-keypair" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "This allows administrative users to operate key-pairs of specified user ID." } }, { "name": "keypair_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The keypair name." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/limits": { "get": { "operationId": "showRateAndAbsoluteLimits", "summary": "Show Rate And Absolute Limits", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-rate-and-absolute-limits" }, "parameters": [ { "name": "reserved", "in": "query", "required": false, "schema": { "type": "integer", "description": "Specify whether the result of resource total includes reserved resources or not." } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify the project ID (tenant ID) to show the rate and absolute limits. This parameter can be specified by admin only." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-aggregates": { "get": { "operationId": "listAggregates", "summary": "List Aggregates", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-aggregates" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createAggregate", "summary": "Create Aggregate", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-aggregate" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "name": { "type": "string" }, "availability_zone": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-aggregates/{aggregate_id}": { "get": { "operationId": "showAggregateDetails", "summary": "Show Aggregate Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-aggregate-details" }, "parameters": [ { "name": "aggregate_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The aggregate ID." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateAggregate", "summary": "Update Aggregate", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-aggregate" }, "parameters": [ { "name": "aggregate_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The aggregate ID." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aggregate": { "type": "object", "properties": { "name": { "type": "string" }, "availability_zone": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteAggregate", "summary": "Delete Aggregate", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-aggregate" }, "parameters": [ { "name": "aggregate_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The aggregate ID." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-aggregates/{aggregate_id}/action": { "post": { "operationId": "addHost", "summary": "Add Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#add-host" }, "parameters": [ { "name": "aggregate_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The aggregate ID." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "add_host": { "type": "object", "properties": { "host": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-aggregates/{aggregate_id}/images": { "post": { "operationId": "requestImagePre-cachingForAggregate", "summary": "Request Image Pre-caching for Aggregate", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#request-image-pre-caching-for-aggregate" }, "parameters": [ { "name": "aggregate_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The aggregate ID." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cache": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-assisted-volume-snapshots": { "post": { "operationId": "createAssistedVolumeSnapshots", "summary": "Create Assisted Volume Snapshots", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-assisted-volume-snapshots" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshot": { "type": "object", "properties": { "volume_id": { "type": "string" }, "create_info": { "type": "object", "properties": { "snapshot_id": { "type": "string" }, "type": { "type": "string" }, "new_file": { "type": "string" }, "id": { "type": "string" } } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-assisted-volume-snapshots/{snapshot_id}": { "delete": { "operationId": "deleteAssistedVolumeSnapshot", "summary": "Delete Assisted Volume Snapshot", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-assisted-volume-snapshot" }, "parameters": [ { "name": "delete_info", "in": "query", "required": true, "schema": { "type": "string", "description": "Information for snapshot deletion. Include the ID of the associated volume. For example:" } }, { "name": "snapshot_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the snapshot." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-availability-zone": { "get": { "operationId": "getAvailabilityZoneInformation", "summary": "Get Availability Zone Information", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#get-availability-zone-information" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-availability-zone/detail": { "get": { "operationId": "getDetailedAvailabilityZoneInformation", "summary": "Get Detailed Availability Zone Information", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#get-detailed-availability-zone-information" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors": { "get": { "operationId": "listHypervisors", "summary": "List Hypervisors", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-hypervisors" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item as a UUID. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "hypervisor_hostname_pattern", "in": "query", "required": false, "schema": { "type": "string", "description": "The hypervisor host name or a portion of it. The hypervisor hosts are selected with the host name matching this pattern." } }, { "name": "with_servers", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include all servers which belong to each hypervisor in the response output." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/detail": { "get": { "operationId": "listHypervisorsDetails", "summary": "List Hypervisors Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-hypervisors-details" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item as a UUID. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "hypervisor_hostname_pattern", "in": "query", "required": false, "schema": { "type": "string", "description": "The hypervisor host name or a portion of it. The hypervisor hosts are selected with the host name matching this pattern." } }, { "name": "with_servers", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include all servers which belong to each hypervisor in the response output." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/statistics": { "get": { "operationId": "showHypervisorStatistics(DEPRECATED)", "summary": "Show Hypervisor Statistics (DEPRECATED)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-hypervisor-statistics-deprecated" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/{hypervisor_id}": { "get": { "operationId": "showHypervisorDetails", "summary": "Show Hypervisor Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-hypervisor-details" }, "parameters": [ { "name": "with_servers", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include all servers which belong to each hypervisor in the response output." } }, { "name": "hypervisor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the hypervisor as a UUID." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/{hypervisor_id}/uptime": { "get": { "operationId": "showHypervisorUptime(DEPRECATED)", "summary": "Show Hypervisor Uptime (DEPRECATED)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-hypervisor-uptime-deprecated" }, "parameters": [ { "name": "hypervisor_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the hypervisor as a UUID." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/{hypervisor_hostname_pattern}/search": { "get": { "operationId": "searchHypervisor(DEPRECATED)", "summary": "Search Hypervisor (DEPRECATED)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#search-hypervisor-deprecated" }, "parameters": [ { "name": "hypervisor_hostname_pattern", "in": "path", "required": true, "schema": { "type": "string", "description": "The hypervisor host name or a portion of it. The hypervisor hosts are selected with the host name matching this pattern." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hypervisors/{hypervisor_hostname_pattern}/servers": { "get": { "operationId": "listHypervisorServers(DEPRECATED)", "summary": "List Hypervisor Servers (DEPRECATED)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-hypervisor-servers-deprecated" }, "parameters": [ { "name": "hypervisor_hostname_pattern", "in": "path", "required": true, "schema": { "type": "string", "description": "The hypervisor host name or a portion of it. The hypervisor hosts are selected with the host name matching this pattern." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-instance_usage_audit_log": { "get": { "operationId": "listServerUsageAudits", "summary": "List Server Usage Audits", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-server-usage-audits" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-instance_usage_audit_log/{before_timestamp}": { "get": { "operationId": "listUsageAuditsBeforeSpecifiedTime", "summary": "List Usage Audits Before Specified Time", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-usage-audits-before-specified-time" }, "parameters": [ { "name": "before_timestamp", "in": "path", "required": true, "schema": { "type": "string", "description": "Filters the response by the date and time before which to list usage audits. The date and time stamp format is as follows:" } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-migrations": { "get": { "operationId": "listMigrations", "summary": "List Migrations", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-migrations" }, "parameters": [ { "name": "hidden", "in": "query", "required": false, "schema": { "type": "integer", "description": "The ‘hidden’ setting of migration to filter. The ‘hidden’ flag is set if the value is 1. The ‘hidden’ flag is not set if the value is 0. But the ‘hidden’ setting of migration is always 0, so this parameter is useless to filter migrations." } }, { "name": "host", "in": "query", "required": false, "schema": { "type": "string", "description": "The source/destination compute node of migration to filter." } }, { "name": "instance_uuid", "in": "query", "required": false, "schema": { "type": "string", "description": "The uuid of the instance that migration is operated on to filter." } }, { "name": "migration_type", "in": "query", "required": false, "schema": { "type": "string", "description": "The type of migration to filter. Valid values are:" } }, { "name": "source_compute", "in": "query", "required": false, "schema": { "type": "string", "description": "The source compute node of migration to filter." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "The status of migration to filter." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The UUID of the last-seen migration. Use the limit parameter to make an initial limited request and use the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the migration last changed. Those changed after the specified date and time stamp are returned." } }, { "name": "changes-before", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time stamp when the migration last changed. Those migrations that changed before or equal to the specified date and time stamp are returned." } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the migrations by the given user ID." } }, { "name": "project_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the migrations by the given project ID." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/migrations": { "get": { "operationId": "listServerMigrations", "summary": "List Migrations", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#id312" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/migrations/{migration_id}": { "get": { "operationId": "showMigrationDetails", "summary": "Show Migration Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-migration-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The ID of the server migration." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "delete(Abort)Migration", "summary": "Delete (Abort) Migration", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-abort-migration" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The ID of the server migration." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/migrations/{migration_id}/action": { "post": { "operationId": "forceMigrationCompleteAction(force_completeAction)", "summary": "Force Migration Complete Action (force_complete Action)", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#force-migration-complete-action-force-complete-action" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "migration_id", "in": "path", "required": true, "schema": { "type": "integer", "description": "The ID of the server migration." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "force_complete": { "type": "string" } } } } } }, "responses": { "202": { "description": "Request was successful." } } } }, "/os-quota-sets/{tenant_id}": { "get": { "operationId": "showAQuota", "summary": "Show A Quota", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-a-quota" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "ID of user to list the quotas for." } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateQuotas", "summary": "Update Quotas", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-quotas" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "ID of user to set the quotas for." } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quota_set": { "type": "object", "properties": { "cores": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "revertQuotasToDefaults", "summary": "Revert Quotas To Defaults", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#revert-quotas-to-defaults" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "ID of user to delete quotas for." } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-quota-sets/{tenant_id}/defaults": { "get": { "operationId": "listDefaultQuotasForTenant", "summary": "List Default Quotas For Tenant", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-default-quotas-for-tenant" }, "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-quota-sets/{tenant_id}/detail": { "get": { "operationId": "showTheDetailOfQuota", "summary": "Show The Detail of Quota", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-the-detail-of-quota" }, "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "description": "ID of user to list the quotas for." } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-quota-class-sets/{id}": { "get": { "operationId": "showTheQuotaForQuotaClass", "summary": "Show the quota for Quota Class", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-the-quota-for-quota-class" }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the quota class. Nova supports the default Quota Class only." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "createOrUpdateQuotasForQuotaClass", "summary": "Create or Update Quotas for Quota Class", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-quotas-for-quota-class" }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the quota class. Nova supports the default Quota Class only." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "quota_class_set": { "type": "object", "properties": { "instances": { "type": "integer" }, "cores": { "type": "integer" }, "ram": { "type": "integer" }, "metadata_items": { "type": "integer" }, "injected_files": { "type": "integer" }, "injected_file_content_bytes": { "type": "integer" }, "injected_file_path_bytes": { "type": "integer" }, "key_pairs": { "type": "integer" }, "server_groups": { "type": "integer" }, "server_group_members": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-server-groups": { "get": { "operationId": "listServerGroups", "summary": "List Server Groups", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-server-groups" }, "parameters": [ { "name": "all_projects", "in": "query", "required": false, "schema": { "type": "string", "description": "Administrator only. Lists server groups for all projects. For example:" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createServerGroup", "summary": "Create Server Group", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-server-group" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "server_group": { "type": "object", "properties": { "name": { "type": "string" }, "policy": { "type": "string" }, "rules": { "type": "object", "properties": { "max_server_per_host": { "type": "integer" } } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-server-groups/{server_group_id}": { "get": { "operationId": "showServerGroupDetails", "summary": "Show Server Group Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-group-details" }, "parameters": [ { "name": "server_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server group." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteServerGroup", "summary": "Delete Server Group", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-server-group" }, "parameters": [ { "name": "server_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server group." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/tags": { "get": { "operationId": "listTags", "summary": "List Tags", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-tags" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "replaceTags", "summary": "Replace Tags", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#replace-tags" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteAllTags", "summary": "Delete All Tags", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-all-tags" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/tags/{tag}": { "get": { "operationId": "checkTagExistence", "summary": "Check Tag Existence", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#check-tag-existence" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag as a string." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "addASingleTag", "summary": "Add a Single Tag", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#add-a-single-tag" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag as a string." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteASingleTag", "summary": "Delete a Single Tag", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-a-single-tag" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "description": "The tag as a string." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-services": { "get": { "operationId": "listComputeServices", "summary": "List Compute Services", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-compute-services" }, "parameters": [ { "name": "binary", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the service list result by binary name of the service." } }, { "name": "host", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter the service list result by the host name." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-services/disable": { "put": { "operationId": "disableSchedulingForAComputeService", "summary": "Disable Scheduling For A Compute Service", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#disable-scheduling-for-a-compute-service" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "binary": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-services/disable-log-reason": { "put": { "operationId": "disableSchedulingForAComputeServiceAndLogDisabledReason", "summary": "Disable Scheduling For A Compute Service and Log Disabled Reason", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#disable-scheduling-for-a-compute-service-and-log-disabled-reason" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "binary": { "type": "string" }, "disabled_reason": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-services/enable": { "put": { "operationId": "enableSchedulingForAComputeService", "summary": "Enable Scheduling For A Compute Service", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#enable-scheduling-for-a-compute-service" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "binary": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-services/force-down": { "put": { "operationId": "updateForcedDown", "summary": "Update Forced Down", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-forced-down" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string" }, "binary": { "type": "string" }, "forced_down": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-services/{service_id}": { "put": { "operationId": "updateComputeService", "summary": "Update Compute Service", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-compute-service" }, "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The id of the service as a uuid. This uniquely identifies the service in a multi-cell deployment." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "disabled_reason": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteComputeService", "summary": "Delete Compute Service", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-compute-service" }, "parameters": [ { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The id of the service as a uuid. This uniquely identifies the service in a multi-cell deployment." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-simple-tenant-usage": { "get": { "operationId": "listTenantUsageStatisticsForAllTenants", "summary": "List Tenant Usage Statistics For All Tenants", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-tenant-usage-statistics-for-all-tenants" }, "parameters": [ { "name": "detailed", "in": "query", "required": false, "schema": { "type": "integer", "description": "Specify the detailed=1 query parameter to get detail information (‘server_usages’ information)." } }, { "name": "end", "in": "query", "required": false, "schema": { "type": "string", "description": "The ending time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones:" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string", "description": "The beginning time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones:" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Calculate usage for the limited number of instances. Use the limit parameter to make an initial limited request and use the last-seen instance UUID from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The last-seen item. Use the limit parameter to make an initial limited request and use the last-seen instance UUID from the response as the marker parameter value in a subsequent limited request." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-simple-tenant-usage/{tenant_id}": { "get": { "operationId": "showUsageStatisticsForTenant", "summary": "Show Usage Statistics For Tenant", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-usage-statistics-for-tenant" }, "parameters": [ { "name": "end", "in": "query", "required": false, "schema": { "type": "string", "description": "The ending time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones:" } }, { "name": "start", "in": "query", "required": false, "schema": { "type": "string", "description": "The beginning time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones:" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Calculate usage for the limited number of instances. Use the limit parameter to make an initial limited request and use the last-seen instance UUID from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The last-seen item. Use the limit parameter to make an initial limited request and use the last-seen instance UUID from the response as the marker parameter value in a subsequent limited request." } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-server-external-events": { "post": { "operationId": "runEvents", "summary": "Run Events", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#run-events" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "tag": { "type": "string" }, "status": { "type": "string" }, "server_uuid": { "type": "string" } } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/topology": { "get": { "operationId": "showServerTopology", "summary": "Show Server Topology", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-server-topology" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/extensions": { "get": { "operationId": "listExtensions", "summary": "List Extensions", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-extensions" }, "responses": { "200": { "description": "Request was successful." } } } }, "/extensions/{alias}": { "get": { "operationId": "showExtensionDetails", "summary": "Show Extension Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-extension-details" }, "parameters": [ { "name": "alias", "in": "path", "required": true, "schema": { "type": "string", "description": "A short name by which this extension is also known." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-networks": { "get": { "operationId": "listNetworks", "summary": "List Networks", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-networks" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createNetwork", "summary": "Create Network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-network" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-networks/add": { "post": { "operationId": "addNetwork", "summary": "Add Network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#add-network" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-networks/{network_id}": { "get": { "operationId": "showNetworkDetails", "summary": "Show Network Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-network-details" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the network." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteNetwork", "summary": "Delete Network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-network" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the network." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-networks/{network_id}/action": { "post": { "operationId": "associateHost", "summary": "Associate Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#associate-host" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the network." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "associate_host": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-volumes": { "get": { "operationId": "listVolumes", "summary": "List Volumes", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-volumes" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createVolume", "summary": "Create Volume", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-volume" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "volume": { "type": "object", "properties": { "availability_zone": { "type": "string", "format": "uri" }, "display_name": { "type": "string" }, "display_description": { "type": "string" }, "size": { "type": "integer" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-volumes/detail": { "get": { "operationId": "listVolumesWithDetails", "summary": "List Volumes With Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-volumes-with-details" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-volumes/{volume_id}": { "get": { "operationId": "showVolumeDetails", "summary": "Show Volume Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-volume-details" }, "parameters": [ { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique ID for a volume." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteVolume", "summary": "Delete Volume", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-volume" }, "parameters": [ { "name": "volume_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The unique ID for a volume." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-snapshots": { "get": { "operationId": "listSnapshots", "summary": "List Snapshots", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-snapshots" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createSnapshot", "summary": "Create Snapshot", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-snapshot" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshot": { "type": "object", "properties": { "display_name": { "type": "string" }, "display_description": { "type": "string" }, "volume_id": { "type": "string" }, "force": { "type": "boolean" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-snapshots/detail": { "get": { "operationId": "listSnapshotsWithDetails", "summary": "List Snapshots With Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-snapshots-with-details" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-snapshots/{snapshot_id}": { "get": { "operationId": "showSnapshotDetails", "summary": "Show Snapshot Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-snapshot-details" }, "parameters": [ { "name": "snapshot_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the snapshot." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteSnapshot", "summary": "Delete Snapshot", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-snapshot" }, "parameters": [ { "name": "snapshot_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the snapshot." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/images": { "get": { "operationId": "listImages", "summary": "List Images", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-images" }, "parameters": [ { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time when the image last changed status. Use this query parameter to check for changes since a previous request rather than re-downloading and re-parsing the full status at each polling interval. If data has changed, the call returns only the items changed since the changes-since time. If data has not changed since the changes-since time, the call returns an empty list. To enable you to keep track of changes, this filter also displays images that were deleted if the changes-since value specifies a date in the last 30 days. Items deleted more than 30 days ago might be returned, but it is not guaranteed. The date and time stamp format is ISO 8601:" } }, { "name": "server", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server, as a URL." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image name, as a string." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image status, as a string. For example, ACTIVE." } }, { "name": "minDisk", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum disk space, in GiB. For example, 100." } }, { "name": "minRam", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum RAM, in MiB. For example, 512." } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image type. For example, snapshot or backup." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/images/detail": { "get": { "operationId": "listImagesWithDetails", "summary": "List Images With Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-images-with-details" }, "parameters": [ { "name": "changes-since", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a date and time when the image last changed status. Use this query parameter to check for changes since a previous request rather than re-downloading and re-parsing the full status at each polling interval. If data has changed, the call returns only the items changed since the changes-since time. If data has not changed since the changes-since time, the call returns an empty list. To enable you to keep track of changes, this filter also displays images that were deleted if the changes-since value specifies a date in the last 30 days. Items deleted more than 30 days ago might be returned, but it is not guaranteed. The date and time stamp format is ISO 8601:" } }, { "name": "server", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a server, as a URL." } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image name, as a string." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image status, as a string. For example, ACTIVE." } }, { "name": "minDisk", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum disk space, in GiB. For example, 100." } }, { "name": "minRam", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by a minimum RAM, in MiB. For example, 512." } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image type. For example, snapshot or backup." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } }, { "name": "marker", "in": "query", "required": false, "schema": { "type": "string", "description": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/images/{image_id}": { "get": { "operationId": "showImageDetails", "summary": "Show Image Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-image-details" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteImage", "summary": "Delete Image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/images/{image_id}/metadata": { "get": { "operationId": "listImageMetadata", "summary": "List Image Metadata", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-image-metadata" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createImageMetadata", "summary": "Create Image Metadata", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-image-metadata" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "kernel_id": { "type": "string" }, "Label": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateImageMetadata", "summary": "Update Image Metadata", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-image-metadata" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "auto_disk_config": { "type": "string" }, "Label": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/images/{image_id}/metadata/{key}": { "get": { "operationId": "showImageMetadataItem", "summary": "Show Image Metadata Item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-image-metadata-item" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "createOrUpdateImageMetadataItem", "summary": "Create Or Update Image Metadata Item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-image-metadata-item" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "auto_disk_config": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteImageMetadataItem", "summary": "Delete Image Metadata Item", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-image-metadata-item" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "description": "The metadata item key, as a string. Maximum length is 255 characters." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-baremetal-nodes": { "get": { "operationId": "listBareMetalNodes", "summary": "List Bare Metal Nodes", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-bare-metal-nodes" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-baremetal-nodes/{node_id}": { "get": { "operationId": "showBareMetalNodeDetails", "summary": "Show Bare Metal Node Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-bare-metal-node-details" }, "parameters": [ { "name": "node_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The node ID." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-tenant-networks": { "get": { "operationId": "listProjectNetworks", "summary": "List Project Networks", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-project-networks" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createProjectNetwork", "summary": "Create Project Network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-project-network" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-tenant-networks/{network_id}": { "get": { "operationId": "showProjectNetworkDetails", "summary": "Show Project Network Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-project-network-details" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the network." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteProjectNetwork", "summary": "Delete Project Network", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-project-network" }, "parameters": [ { "name": "network_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the network." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ip-pools": { "get": { "operationId": "listFloatingIpPools", "summary": "List Floating Ip Pools", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-floating-ip-pools" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ips": { "get": { "operationId": "listFloatingIpAddresses", "summary": "List Floating Ip Addresses", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-floating-ip-addresses" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "create(Allocate)FloatingIpAddress", "summary": "Create (Allocate) Floating Ip Address", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pool": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ips/{floating_ip_id}": { "get": { "operationId": "showFloatingIpAddressDetails", "summary": "Show Floating Ip Address Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-floating-ip-address-details" }, "parameters": [ { "name": "floating_ip_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the floating IP address." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "delete(Deallocate)FloatingIpAddress", "summary": "Delete (Deallocate) Floating Ip Address", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-deallocate-floating-ip-address" }, "parameters": [ { "name": "floating_ip_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the floating IP address." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-groups": { "get": { "operationId": "listSecurityGroups", "summary": "List Security Groups", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-security-groups" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } }, { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify the all_tenants query parameter to list all security groups for all projects. This is only allowed for admin users. Value of this query parameter is not checked, only presence is considered as request for all tenants." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createSecurityGroup", "summary": "Create Security Group", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-security-group" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "security_group": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-groups/{security_group_id}": { "get": { "operationId": "showSecurityGroupDetails", "summary": "Show Security Group Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-security-group-details" }, "parameters": [ { "name": "security_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the security group." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateSecurityGroup", "summary": "Update Security Group", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-security-group" }, "parameters": [ { "name": "security_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the security group." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "security_group": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteSecurityGroup", "summary": "Delete Security Group", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-security-group" }, "parameters": [ { "name": "security_group_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the security group." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-group-rules": { "post": { "operationId": "createSecurityGroupRule", "summary": "Create Security Group Rule", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-security-group-rule" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "security_group_rule": { "type": "object", "properties": { "parent_group_id": { "type": "string" }, "ip_protocol": { "type": "string" }, "from_port": { "type": "integer" }, "to_port": { "type": "integer" }, "cidr": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-group-rules/{security_group_rule_id}": { "delete": { "operationId": "deleteSecurityGroupRule", "summary": "Delete Security Group Rule", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-security-group-rule" }, "parameters": [ { "name": "security_group_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the security group rule." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hosts": { "get": { "operationId": "listHosts", "summary": "List Hosts", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-hosts" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-hosts/{host_name}": { "get": { "operationId": "showHostDetails", "summary": "Show Host Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-host-details" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateHostStatus", "summary": "Update Host status", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-host-status" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "maintenance_mode": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-hosts/{host_name}/reboot": { "get": { "operationId": "rebootHost", "summary": "Reboot Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#reboot-host" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hosts/{host_name}/shutdown": { "get": { "operationId": "shutDownHost", "summary": "Shut Down Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#shut-down-host" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-hosts/{host_name}/startup": { "get": { "operationId": "startHost", "summary": "Start Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#start-host" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-certificates": { "post": { "operationId": "createRootCertificate", "summary": "Create Root Certificate", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-root-certificate" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-certificates/root": { "get": { "operationId": "showRootCertificateDetails", "summary": "Show Root Certificate Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-root-certificate-details" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-cloudpipe": { "get": { "operationId": "listCloudpipes", "summary": "List Cloudpipes", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-cloudpipes" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createCloudpipe", "summary": "Create Cloudpipe", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-cloudpipe" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cloudpipe": { "type": "object", "properties": { "project_id": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-cloudpipe/configure-project": { "put": { "operationId": "updateCloudpipe", "summary": "Update Cloudpipe", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-cloudpipe" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "configure_project": { "type": "object", "properties": { "vpn_ip": { "type": "string", "format": "ip-address" }, "vpn_port": { "type": "string", "format": "utc-millisec" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-fping": { "get": { "operationId": "pingInstances", "summary": "Ping Instances", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#ping-instances" }, "parameters": [ { "name": "all_tenants", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify the all_tenants query parameter to ping instances for all tenants. By default this is only allowed by admin users. Value of this query parameter is not checked, only presence is considered as request for all tenants." } }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify include=uuid[,uuid...] to include the instances in the results." } }, { "name": "exclude", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify exclude=uuid[,uuid...] to exclude the instances from the results." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-fping/{instance_id}": { "get": { "operationId": "pingAnInstance", "summary": "Ping An Instance", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#ping-an-instance" }, "parameters": [ { "name": "instance_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the instance." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/os-virtual-interfaces": { "get": { "operationId": "listVirtualInterfaces", "summary": "List Virtual Interfaces", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-virtual-interfaces" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } }, { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-fixed-ips/{fixed_ip}": { "get": { "operationId": "showFixedIpDetails", "summary": "Show Fixed Ip Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-fixed-ip-details" }, "parameters": [ { "name": "fixed_ip", "in": "path", "required": true, "schema": { "type": "string", "description": "The fixed IP of interest to you." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-fixed-ips/{fixed_ip}/action": { "post": { "operationId": "reserveOrReleaseAFixedIp", "summary": "Reserve Or Release A Fixed Ip", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#reserve-or-release-a-fixed-ip" }, "parameters": [ { "name": "fixed_ip", "in": "path", "required": true, "schema": { "type": "string", "description": "The fixed IP of interest to you." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reserve": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ips-bulk": { "get": { "operationId": "listFloatingIps", "summary": "List Floating Ips", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-floating-ips" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createFloatingIps", "summary": "Create Floating Ips", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-floating-ips" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "floating_ips_bulk_create": { "type": "object", "properties": { "ip_range": { "type": "string" }, "pool": { "type": "string" }, "interface": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ips-bulk/delete": { "put": { "operationId": "bulk-DeleteFloatingIps", "summary": "Bulk-Delete Floating Ips", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#bulk-delete-floating-ips" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ip_range": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ips-bulk/{host_name}": { "get": { "operationId": "listFloatingIpsByHost", "summary": "List Floating Ips By Host", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-floating-ips-by-host" }, "parameters": [ { "name": "host_name", "in": "path", "required": true, "schema": { "type": "string", "description": "The name of the host." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ip-dns": { "get": { "operationId": "listDNSDomains", "summary": "List DNS Domains", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-dns-domains" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ip-dns/{domain}": { "put": { "operationId": "createOrUpdateDNSDomain", "summary": "Create Or Update DNS Domain", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-dns-domain" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteDNSDomain", "summary": "Delete DNS Domain", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-dns-domain" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ip-dns/{domain}/entries/{ip}": { "get": { "operationId": "listDNSEntries", "summary": "List DNS Entries", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-dns-entries" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } }, { "name": "ip", "in": "path", "required": true, "schema": { "type": "string", "description": "The IP address." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-floating-ip-dns/{domain}/entries/{name}": { "get": { "operationId": "findUniqueDNSEntry", "summary": "Find Unique DNS Entry", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#find-unique-dns-entry" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "description": "The security group name." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "createOrUpdateDNSEntry", "summary": "Create Or Update DNS Entry", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-or-update-dns-entry" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "description": "The security group name." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dns_entry": { "type": "object", "properties": { "ip": { "type": "string", "format": "ip-address" }, "dns_type": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteDNSEntry", "summary": "Delete DNS Entry", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-dns-entry" }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "description": "The registered DNS domain that the DNS drivers publish." } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "description": "The security group name." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells": { "get": { "operationId": "listCells", "summary": "List Cells", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-cells" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } }, { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "description": "The UUID of the tenant in a multi-tenancy cloud." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createCell", "summary": "Create Cell", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-cell" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells/capacities": { "get": { "operationId": "capacities", "summary": "Capacities", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#capacities" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells/detail": { "get": { "operationId": "listCellsWithDetails", "summary": "List Cells With Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-cells-with-details" }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with offset to return a slice of items. limit is the maximum number of items to return. If limit is not specified, or exceeds the configurable max_limit, then max_limit will be used instead." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "description": "Used in conjunction with limit to return a slice of items. offset is where to start in the list." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells/info": { "get": { "operationId": "infoForThisCell", "summary": "Info For This Cell", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#info-for-this-cell" }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells/{cell_id}": { "get": { "operationId": "showCellData", "summary": "Show Cell Data", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-cell-data" }, "parameters": [ { "name": "cell_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the cell." } } ], "responses": { "200": { "description": "Request was successful." } } }, "put": { "operationId": "updateACell", "summary": "Update a Cell", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-a-cell" }, "parameters": [ { "name": "cell_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the cell." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteACell", "summary": "Delete a Cell", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-a-cell" }, "parameters": [ { "name": "cell_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the cell." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-cells/{cell_id}/capacities": { "get": { "operationId": "showCellCapacities", "summary": "Show Cell Capacities", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-cell-capacities" }, "parameters": [ { "name": "cell_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the cell." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/consoles": { "get": { "operationId": "listsConsoles", "summary": "Lists Consoles", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#lists-consoles" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createConsoleForServer", "summary": "Create Console", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#id556" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/servers/{server_id}/consoles/{console_id}": { "get": { "operationId": "showConsoleDetails", "summary": "Show Console Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-console-details" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "console_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the console." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteConsole", "summary": "Delete Console", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-console" }, "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the server." } }, { "name": "console_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the console." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-group-default-rules": { "get": { "operationId": "listDefaultSecurityGroupRules", "summary": "List Default Security Group Rules", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-default-security-group-rules" }, "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createDefaultSecurityGroupRule", "summary": "Create Default Security Group Rule", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-default-security-group-rule" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "security_group_default_rule": { "type": "object", "properties": { "ip_protocol": { "type": "string" }, "from_port": { "type": "string", "format": "utc-millisec" }, "to_port": { "type": "string", "format": "utc-millisec" }, "cidr": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-security-group-default-rules/{security_group_default_rule_id}": { "get": { "operationId": "showDefaultSecurityGroupRuleDetails", "summary": "Show Default Security Group Rule Details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#show-default-security-group-rule-details" }, "parameters": [ { "name": "security_group_default_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the security group rule." } } ], "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteDefaultSecurityGroupRule", "summary": "Delete Default Security Group Rule", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-default-security-group-rule" }, "parameters": [ { "name": "security_group_default_rule_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the security group rule." } } ], "responses": { "200": { "description": "Request was successful." } } } }, "/os-agents": { "get": { "operationId": "listAgentBuilds", "summary": "List Agent Builds", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#list-agent-builds" }, "parameters": [ { "name": "hypervisor", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a hypervisor type." } } ], "responses": { "200": { "description": "Request was successful." } } }, "post": { "operationId": "createAgentBuild", "summary": "Create Agent Build", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#create-agent-build" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agent": { "type": "object", "properties": { "hypervisor": { "type": "string" }, "os": { "type": "string" }, "architecture": { "type": "string" }, "version": { "type": "string", "format": "utc-millisec" }, "md5hash": { "type": "string" }, "url": { "type": "string", "format": "uri" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } } }, "/os-agents/{agent_build_id}": { "put": { "operationId": "updateAgentBuild", "summary": "Update Agent Build", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#update-agent-build" }, "parameters": [ { "name": "agent_build_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The id of the agent build." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "para": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "md5hash": { "type": "string" }, "version": { "type": "string", "format": "utc-millisec" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } } }, "delete": { "operationId": "deleteAgentBuild", "summary": "Delete Agent Build", "externalDocs": { "url": "https://docs.openstack.org/api-ref/compute/#delete-agent-build" }, "parameters": [ { "name": "agent_build_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The id of the agent build." } } ], "responses": { "200": { "description": "Request was successful." } } } } }, "components": { "schemas": {}, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "token": { "type": "apiKey", "description": "Token authentication", "name": "X-Auth-Token", "in": "header" } }, "links": {}, "callbacks": {} }, "security": [ { "token": [] } ], "tags": [], "externalDocs": { "description": "Openstack Nova Compute API Operations", "url": "https://docs.openstack.org/api-ref/compute/" } }