@netzreich/openstack-clients

openapi: 3.1.0 info: title: OpenStack Compute API description: Compute API provided by Nova service version: '2.96' paths: /v2.1/: get: operationId: :get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/RootShowResponse' tags: - version /v2.1/versions/{id}: parameters: - $ref: '#/components/parameters/versions_id' get: operationId: versions/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/VersionShowResponse' tags: - version /v2.1/extensions: get: operationId: extensions:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ExtensionsListResponse' tags: - extensions /v2.1/extensions/{id}: parameters: - $ref: '#/components/parameters/extensions_id' get: operationId: extensions/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ExtensionShowResponse' tags: - extensions /v2.1/flavors: get: parameters: - $ref: '#/components/parameters/flavors_limit' - $ref: '#/components/parameters/flavors_marker' - $ref: '#/components/parameters/flavors_is_public' - $ref: '#/components/parameters/flavors_minRam' - $ref: '#/components/parameters/flavors_minDisk' - $ref: '#/components/parameters/flavors_sort_key' - $ref: '#/components/parameters/flavors_sort_dir' description: |2- Return all flavors in brief. operationId: flavors:get responses: '400': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsListResponse' tags: - flavors post: operationId: flavors:post requestBody: content: application/json: schema: $ref: '#/components/schemas/FlavorsCreateRequest' responses: '400': description: Error '409': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsCreateResponse' tags: - flavors /v2.1/flavors/detail: get: parameters: - $ref: '#/components/parameters/flavors_detail_limit' - $ref: '#/components/parameters/flavors_detail_marker' - $ref: '#/components/parameters/flavors_detail_is_public' - $ref: '#/components/parameters/flavors_detail_minRam' - $ref: '#/components/parameters/flavors_detail_minDisk' - $ref: '#/components/parameters/flavors_detail_sort_key' - $ref: '#/components/parameters/flavors_detail_sort_dir' description: |2- Return all flavors in detail. operationId: flavors/detail:get responses: '400': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsDetailResponse' tags: - flavors /v2.1/flavors/{id}: parameters: - $ref: '#/components/parameters/flavors_id' get: description: |2- Return data about the given flavor id. operationId: flavors/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorShowResponse' tags: - flavors delete: operationId: flavors/id:delete responses: '404': description: Error '202': description: Ok tags: - flavors put: operationId: flavors/id:put requestBody: content: application/json: schema: $ref: '#/components/schemas/FlavorUpdate_255' responses: '400': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorUpdateResponse' tags: - flavors x-openstack: min-ver: '2.55' /v2.1/flavors/{id}/action: parameters: - $ref: '#/components/parameters/flavors_action_id' post: operationId: flavors/id/action:post requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/FlavorsAction_Add_Tenant_Access' - $ref: '#/components/schemas/FlavorsAction_Remove_Tenant_Access' x-openstack: discriminator: action responses: '400': description: Error '403': description: Error '404': description: Error '409': description: Error '201': description: Ok content: application/json: schema: oneOf: - $ref: '#/components/schemas/FlavorsActionAddtenantaccessResponse' - $ref: '#/components/schemas/FlavorsActionRemovetenantaccessResponse' tags: - flavors /v2.1/flavors/{flavor_id}/os-extra_specs: parameters: - $ref: '#/components/parameters/flavors_os_extra_specs_flavor_id' get: description: |2- Returns the list of extra specs for a given flavor. operationId: flavors/flavor_id/os-extra_specs:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecsListResponse' tags: - flavors post: operationId: flavors/flavor_id/os-extra_specs:post requestBody: content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecsCreate' responses: '400': description: Error '404': description: Error '409': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecsCreateResponse' tags: - flavors /v2.1/flavors/{flavor_id}/os-extra_specs/{id}: parameters: - $ref: '#/components/parameters/flavors_os_extra_specs_flavor_id' - $ref: '#/components/parameters/flavors_os_extra_specs_id' get: description: |2- Return a single extra spec item. operationId: flavors/flavor_id/os-extra_specs/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecShowResponse' tags: - flavors delete: description: |2- Deletes an existing extra spec. operationId: flavors/flavor_id/os-extra_specs/id:delete responses: '404': description: Error '204': description: Ok tags: - flavors put: operationId: flavors/flavor_id/os-extra_specs/id:put requestBody: content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecUpdate' responses: '400': description: Error '404': description: Error '409': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecUpdateResponse' tags: - flavors /v2.1/flavors/{flavor_id}/os-flavor-access: parameters: - $ref: '#/components/parameters/flavors_os_flavor_access_flavor_id' get: operationId: flavors/flavor_id/os-flavor-access:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/FlavorsOs_Flavor_AccessListResponse' tags: - flavors /v2.1/images: get: parameters: - $ref: '#/components/parameters/images_name' - $ref: '#/components/parameters/images_status' - $ref: '#/components/parameters/images_changes-since' - $ref: '#/components/parameters/images_server' - $ref: '#/components/parameters/images_type' - $ref: '#/components/parameters/images_minRam' - $ref: '#/components/parameters/images_minDisk' - $ref: '#/components/parameters/images_limit' - $ref: '#/components/parameters/images_page_size' - $ref: '#/components/parameters/images_marker' - $ref: '#/components/parameters/images_offset' description: |2- Return an index listing of images available to the request. | param req: | wsgi.Request object | | --- | --- | operationId: images:get responses: '400': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesListResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/images/detail: get: parameters: - $ref: '#/components/parameters/images_detail_name' - $ref: '#/components/parameters/images_detail_status' - $ref: '#/components/parameters/images_detail_changes-since' - $ref: '#/components/parameters/images_detail_server' - $ref: '#/components/parameters/images_detail_type' - $ref: '#/components/parameters/images_detail_minRam' - $ref: '#/components/parameters/images_detail_minDisk' - $ref: '#/components/parameters/images_detail_limit' - $ref: '#/components/parameters/images_detail_page_size' - $ref: '#/components/parameters/images_detail_marker' - $ref: '#/components/parameters/images_detail_offset' description: |2- Return a detailed index listing of images available to the request. | param req: | wsgi.Request object. | | --- | --- | operationId: images/detail:get responses: '400': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesDetailResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/images/{id}: parameters: - $ref: '#/components/parameters/images_id' get: description: |2- Return detailed information about a specific image. | param req: | wsgi.Request object | | --- | --- | | param id: | Image identifier | operationId: images/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImageShowResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' delete: description: |2- Delete an image, if allowed. | param req: | wsgi.Request object | | --- | --- | | param id: | Image identifier (integer) | operationId: images/id:delete responses: '403': description: Error '404': description: Error '204': description: Ok tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/images/{image_id}/metadata: parameters: - $ref: '#/components/parameters/images_metadata_image_id' get: description: |2- Returns the list of metadata for a given instance. operationId: images/image_id/metadata:get responses: '403': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataListResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' post: operationId: images/image_id/metadata:post requestBody: content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataCreate' responses: '400': description: Error '403': description: Error '404': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataCreateResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' put: operationId: images/image_id/metadata:put requestBody: content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataUpdate_All' responses: '400': description: Error '403': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' /v2.1/images/{image_id}/metadata/{id}: parameters: - $ref: '#/components/parameters/images_metadata_image_id' - $ref: '#/components/parameters/images_metadata_id' get: operationId: images/image_id/metadata/id:get responses: '403': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataShowResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' delete: operationId: images/image_id/metadata/id:delete responses: '403': description: Error '404': description: Error '204': description: Ok tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' put: operationId: images/image_id/metadata/id:put requestBody: content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataUpdate' responses: '400': description: Error '403': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/ImagesMetadataUpdateResponse' tags: - images deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.38' /v2.1/limits: get: parameters: - $ref: '#/components/parameters/limits_tenant_id' operationId: limits:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/LimitsListResponse' tags: - limits deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.56' /v2.1/os-agents: get: operationId: os-agents:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AgentsListResponse' tags: - os-agents deprecated: true post: operationId: os-agents:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AgentsCreateResponse' tags: - os-agents deprecated: true /v2.1/os-agents/{id}: parameters: - $ref: '#/components/parameters/os_agents_id' delete: operationId: os-agents/id:delete responses: '410': description: Error '204': description: Ok tags: - os-agents deprecated: true put: operationId: os-agents/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AgentUpdateResponse' tags: - os-agents deprecated: true /v2.1/os-aggregates: get: description: |2- Returns a list a host aggregate's id, name, availability_zone. operationId: os-aggregates:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AggregatesListResponse' tags: - os-aggregates post: description: |2- Creates an aggregate, given its name and optional availability zone. operationId: os-aggregates:post requestBody: content: application/json: schema: $ref: '#/components/schemas/Os_AggregatesCreateRequest' responses: '400': description: Error '409': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AggregatesCreateResponse' tags: - os-aggregates /v2.1/os-aggregates/{id}: parameters: - $ref: '#/components/parameters/os_aggregates_id' get: description: |2- Shows the details of an aggregate, hosts and metadata included. operationId: os-aggregates/id:get responses: '400': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AggregateShowResponse' tags: - os-aggregates delete: description: |2- Removes an aggregate by id. operationId: os-aggregates/id:delete responses: '400': description: Error '404': description: Error '204': description: Ok tags: - os-aggregates put: description: |2- Updates the name and/or availability_zone of given aggregate. operationId: os-aggregates/id:put requestBody: content: application/json: schema: $ref: '#/components/schemas/Os_AggregateUpdateRequest' responses: '400': description: Error '404': description: Error '409': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_AggregateUpdateResponse' tags: - os-aggregates /v2.1/os-aggregates/{id}/action: parameters: - $ref: '#/components/parameters/os_aggregates_action_id' post: operationId: os-aggregates/id/action:post requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_AggregatesAction_Add_Host' - $ref: '#/components/schemas/Os_AggregatesAction_Remove_Host' - $ref: '#/components/schemas/Os_AggregatesAction_Set_Metadata' x-openstack: discriminator: action responses: '400': description: Error '404': description: Error '409': description: Error '201': description: Ok content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_AggregatesActionAdd_HostResponse' - $ref: '#/components/schemas/Os_AggregatesActionRemove_HostResponse' - $ref: '#/components/schemas/Os_AggregatesActionSet_MetadataResponse' tags: - os-aggregates /v2.1/os-aggregates/{id}/images: parameters: - $ref: '#/components/parameters/os_aggregates_images_id' post: description: |2- Allows image cache management requests. operationId: os-aggregates/id/images:post requestBody: content: application/json: schema: $ref: '#/components/schemas/Os_AggregatesImagesImages' responses: '400': description: Error '404': description: Error '202': description: Ok tags: - os-aggregates x-openstack: min-ver: '2.81' /v2.1/os-assisted-volume-snapshots: post: description: |2- Creates a new snapshot. operationId: os-assisted-volume-snapshots:post requestBody: content: application/json: schema: $ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreate' responses: '400': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreateResponse' tags: - os-assisted-volume-snapshots /v2.1/os-assisted-volume-snapshots/{id}: parameters: - $ref: '#/components/parameters/os_assisted_volume_snapshots_id' delete: parameters: - $ref: '#/components/parameters/os_assisted_volume_snapshot_delete_info' description: |2- Delete a snapshot. operationId: os-assisted-volume-snapshots/id:delete responses: '400': description: Error '404': description: Error '204': description: Ok tags: - os-assisted-volume-snapshots /v2.1/os-availability-zone: get: description: |2- Returns a summary list of availability zone. operationId: os-availability-zone:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Availability_ZoneListResponse' tags: - os-availability-zone /v2.1/os-availability-zone/detail: get: description: |2- Returns a detailed list of availability zone. operationId: os-availability-zone/detail:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Availability_ZoneDetailResponse' tags: - os-availability-zone /v2.1/os-baremetal-nodes: get: operationId: os-baremetal-nodes:get responses: '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Baremetal_NodesListResponse' tags: - os-baremetal-nodes deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' post: operationId: os-baremetal-nodes:post responses: '400': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Baremetal_NodesCreateResponse' tags: - os-baremetal-nodes deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/os-baremetal-nodes/{id}: parameters: - $ref: '#/components/parameters/os_baremetal_nodes_id' get: operationId: os-baremetal-nodes/id:get responses: '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Baremetal_NodeShowResponse' tags: - os-baremetal-nodes deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' delete: operationId: os-baremetal-nodes/id:delete responses: '400': description: Error '204': description: Ok tags: - os-baremetal-nodes deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/os-baremetal-nodes/{id}/action: parameters: - $ref: '#/components/parameters/os_baremetal_nodes_action_id' post: operationId: os-baremetal-nodes/id/action:post requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_Baremetal_NodesActionAdd_InterfaceRequest' - $ref: '#/components/schemas/Os_Baremetal_NodesActionRemove_InterfaceRequest' x-openstack: discriminator: action responses: '400': description: Error '201': description: Ok content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_Baremetal_NodesActionAdd_InterfaceResponse' - $ref: '#/components/schemas/Os_Baremetal_NodesActionRemove_InterfaceResponse' tags: - os-baremetal-nodes /v2.1/os-cells: get: operationId: os-cells:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsListResponse' tags: - os-cells deprecated: true post: operationId: os-cells:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsCreateResponse' tags: - os-cells deprecated: true /v2.1/os-cells/capacities: get: operationId: os-cells/capacities:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsCapacitiesResponse' tags: - os-cells deprecated: true /v2.1/os-cells/detail: get: operationId: os-cells/detail:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsDetailResponse' tags: - os-cells deprecated: true /v2.1/os-cells/info: get: operationId: os-cells/info:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsInfoResponse' tags: - os-cells deprecated: true /v2.1/os-cells/sync_instances: post: operationId: os-cells/sync_instances:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsSync_InstancesResponse' tags: - os-cells deprecated: true /v2.1/os-cells/{id}: parameters: - $ref: '#/components/parameters/os_cells_id' get: operationId: os-cells/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellShowResponse' tags: - os-cells deprecated: true delete: operationId: os-cells/id:delete responses: '410': description: Error '204': description: Ok tags: - os-cells deprecated: true put: operationId: os-cells/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellUpdateResponse' tags: - os-cells deprecated: true /v2.1/os-cells/{id}/capacities: parameters: - $ref: '#/components/parameters/os_cells_capacities_id' get: operationId: os-cells/id/capacities:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CellsCapacitiesResponse' tags: - os-cells deprecated: true /v2.1/os-certificates: post: description: |2- Create a certificate. operationId: os-certificates:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CertificatesCreateResponse' tags: - os-certificates deprecated: true /v2.1/os-certificates/{id}: parameters: - $ref: '#/components/parameters/os_certificates_id' get: description: |2- Return certificate information. operationId: os-certificates/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CertificateShowResponse' tags: - os-certificates deprecated: true /v2.1/os-cloudpipe: get: description: |2- List running cloudpipe instances. operationId: os-cloudpipe:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CloudpipeListResponse' tags: - os-cloudpipe deprecated: true post: description: |2- Create a new cloudpipe instance, if none exists. operationId: os-cloudpipe:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CloudpipeCreateResponse' tags: - os-cloudpipe deprecated: true /v2.1/os-cloudpipe/{id}: parameters: - $ref: '#/components/parameters/os_cloudpipe_id' put: description: |2- Configure cloudpipe parameters for the project. operationId: os-cloudpipe/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_CloudpipeUpdateResponse' tags: - os-cloudpipe deprecated: true /v2.1/os-console-auth-tokens/{id}: parameters: - $ref: '#/components/parameters/os_console_auth_tokens_id' get: description: |2- Until microversion 2\.30, this API was available only for the rdp\-html5 console type which has been removed along with the HyperV driver in the Nova 29\.0\.0 (Caracal) release. As this method is for microversion \<\=2\.30, it will return an http 400 error. Starting from 2\.31 microversion, this API works for all the supported console types that are handled by the separate show method defined below. operationId: os-console-auth-tokens/id:get responses: '400': description: Error '401': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse' tags: - server-consoles deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.30' /v2.1/os-fixed-ips/{id}: parameters: - $ref: '#/components/parameters/os_fixed_ips_id' get: operationId: os-fixed-ips/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Fixed_IpShowResponse' tags: - os-fixed-ips deprecated: true /v2.1/os-fixed-ips/{id}/action: parameters: - $ref: '#/components/parameters/os_fixed_ips_action_id' post: operationId: os-fixed-ips/id/action:post requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_Fixed_IpsActionReserveRequest' - $ref: '#/components/schemas/Os_Fixed_IpsActionUnreserveRequest' x-openstack: discriminator: action responses: '410': description: Error '201': description: Ok content: application/json: schema: oneOf: - $ref: '#/components/schemas/Os_Fixed_IpsActionReserveResponse' - $ref: '#/components/schemas/Os_Fixed_IpsActionUnreserveResponse' tags: - os-fixed-ips /v2.1/os-floating-ip-dns: get: operationId: os-floating-ip-dns:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ip_DnsListResponse' tags: - os-floating-ip-dns deprecated: true /v2.1/os-floating-ip-dns/{id}: parameters: - $ref: '#/components/parameters/os_floating_ip_dns_id' delete: operationId: os-floating-ip-dns/id:delete responses: '410': description: Error '204': description: Ok tags: - os-floating-ip-dns deprecated: true put: operationId: os-floating-ip-dns/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ip_DnUpdateResponse' tags: - os-floating-ip-dns deprecated: true /v2.1/os-floating-ip-dns/{domain_id}/entries/{id}: parameters: - $ref: '#/components/parameters/os_floating_ip_dns_entries_domain_id' - $ref: '#/components/parameters/os_floating_ip_dns_entries_id' get: operationId: os-floating-ip-dns/domain_id/entries/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ip_DnsEntryShowResponse' tags: - os-floating-ip-dns deprecated: true delete: operationId: os-floating-ip-dns/domain_id/entries/id:delete responses: '410': description: Error '204': description: Ok tags: - os-floating-ip-dns deprecated: true put: operationId: os-floating-ip-dns/domain_id/entries/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ip_DnsEntryUpdateResponse' tags: - os-floating-ip-dns deprecated: true /v2.1/os-floating-ip-pools: get: description: |2- Return a list of pools. operationId: os-floating-ip-pools:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ip_PoolsListResponse' tags: - os-floating-ip-pools deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/os-floating-ips: get: description: |2- Return a list of floating IPs allocated to a project. operationId: os-floating-ips:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_IpsListResponse' tags: - os-floating-ips deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' post: operationId: os-floating-ips:post responses: '400': description: Error '403': description: Error '404': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_IpsCreateResponse' tags: - os-floating-ips deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/os-floating-ips/{id}: parameters: - $ref: '#/components/parameters/os_floating_ips_id' get: description: |2- Return data about the given floating IP. operationId: os-floating-ips/id:get responses: '400': description: Error '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_IpShowResponse' tags: - os-floating-ips deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' delete: operationId: os-floating-ips/id:delete responses: '400': description: Error '403': description: Error '404': description: Error '409': description: Error '202': description: Ok tags: - os-floating-ips deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.35' /v2.1/os-floating-ips-bulk: get: operationId: os-floating-ips-bulk:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ips_BulkListResponse' tags: - os-floating-ips-bulk deprecated: true post: operationId: os-floating-ips-bulk:post responses: '410': description: Error '201': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ips_BulkCreateResponse' tags: - os-floating-ips-bulk deprecated: true /v2.1/os-floating-ips-bulk/{id}: parameters: - $ref: '#/components/parameters/os_floating_ips_bulk_id' get: operationId: os-floating-ips-bulk/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ips_BulkShowResponse' tags: - os-floating-ips-bulk deprecated: true put: operationId: os-floating-ips-bulk/id:put responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_Floating_Ips_BulkUpdateResponse' tags: - os-floating-ips-bulk deprecated: true /v2.1/os-fping: get: operationId: os-fping:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_FpingListResponse' tags: - os-fping deprecated: true /v2.1/os-fping/{id}: parameters: - $ref: '#/components/parameters/os_fping_id' get: operationId: os-fping/id:get responses: '410': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_FpingShowResponse' tags: - os-fping deprecated: true /v2.1/os-hosts: get: parameters: - $ref: '#/components/parameters/os_hosts_zone' description: |2- Returns a dict in the format {'hosts': \[{'host_name': 'some.host.name', 'service': 'cells', 'zone': 'internal'}, {'host_name': 'some.other.host.name', 'service': 'cells', 'zone': 'internal'}, {'host_name': 'some.celly.host.name', 'service': 'cells', 'zone': 'internal'}, {'host_name': 'compute1\.host.com', 'service': 'compute', 'zone': 'nova'}, {'host_name': 'compute2\.host.com', 'service': 'compute', 'zone': 'nova'}, {'host_name': 'sched1\.host.com', 'service': 'scheduler', 'zone': 'internal'}, {'host_name': 'sched2\.host.com', 'service': 'scheduler', 'zone': 'internal'}, {'host_name': 'vol1\.host.com', 'service': 'volume', 'zone': 'internal'}]} operationId: os-hosts:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostsListResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' /v2.1/os-hosts/{id}: parameters: - $ref: '#/components/parameters/os_hosts_id' get: description: |2- Shows the physical/usage resource given by hosts. | param id: | hostname | | --- | --- | | returns: | expected to use HostShowTemplate. ex.: ``` {'host': {'resource':D},..} D: {'host': 'hostname','project': 'admin', 'cpu': 1, 'memory_mb': 2048, 'disk_gb': 30} ``` | operationId: os-hosts/id:get responses: '404': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostShowResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' put: description: |2- Return booleanized version of body dict. | param Request req: | | | --- | --- | | | The request object (containing 'nova\-context' env var). | | param str id: | The host name. | | param dict body: | | | | example format {'host': {'status': 'enable', 'maintenance_mode': 'enable'}} | | return: | Same dict as body but 'enable' strings for 'status' and 'maintenance_mode' are converted into True, else False. | | rtype: | dict | operationId: os-hosts/id:put requestBody: content: application/json: schema: $ref: '#/components/schemas/Os_HostUpdate' responses: '400': description: Error '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostUpdateResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' /v2.1/os-hosts/{id}/reboot: parameters: - $ref: '#/components/parameters/os_hosts_reboot_id' get: operationId: os-hosts/id/reboot:get responses: '400': description: Error '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostsRebootResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' /v2.1/os-hosts/{id}/shutdown: parameters: - $ref: '#/components/parameters/os_hosts_shutdown_id' get: operationId: os-hosts/id/shutdown:get responses: '400': description: Error '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostsShutdownResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' /v2.1/os-hosts/{id}/startup: parameters: - $ref: '#/components/parameters/os_hosts_startup_id' get: operationId: os-hosts/id/startup:get responses: '400': description: Error '404': description: Error '501': description: Error '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HostsStartupResponse' tags: - os-hosts deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.42' /v2.1/os-hypervisors: get: parameters: - $ref: '#/components/parameters/os_hypervisors_limit' - $ref: '#/components/parameters/os_hypervisors_marker' - $ref: '#/components/parameters/os_hypervisors_hypervisor_hostname_pattern' - $ref: '#/components/parameters/os_hypervisors_with_servers' description: |2- Starting with the 2\.53 microversion, the id field in the response is the compute_nodes.uuid value. Also, the search and servers routes are superseded and replaced with query parameters for listing hypervisors by a hostname pattern and whether or not to include hosted servers in the response. operationId: os-hypervisors:get responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/Os_HypervisorsListResponse' '400': description: Error '404': description: Error tags: - os-hypervisors deprecated: true x-openstack: min-ver: '2.1' max-ver: '2.52' /v2.1/os-hypervisors/detail: get: parameters: - $ref: '#/components/parameters/os_hypervisors_detail_limit' - $ref: '#/components/parameters/os_hypervisors_detail_marker' - $ref: '#/components/parameters/os_hypervisors_detail_hypervisor_hostname_pattern' - $ref: '#/components/parameters/os_hypervisors_detail_with_servers' description: |2- Starting with the 2\.53 microversion, the id field in the response is the compute_nodes.uuid value. Also, the search and servers routes are superseded and replac