@itentialopensource/adapter-openstack_nova
Version:
This adapter integrates with system described as: Opensatck Compute (Nova) Service.
1,495 lines • 226 kB
JSON
{
"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 numb