@itentialopensource/adapter-openstack_glance

{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Openstack Glance API" }, "servers": [ { "url": "http://{host}:{port}", "description": "Image service (glance) administrative endpoint", "variables": { "host": { "default": "localhost" }, "port": { "default": "9292" } } } ], "paths": { "/v2/images": { "post": { "operationId": "createImage", "summary": "Create image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-image" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "container_format": { "type": "string" }, "disk_format": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } } } } }, "responses": { "201": { "description": "Request was successful." } }, "tags": [ "Images" ] }, "get": { "operationId": "listImages", "summary": "List images", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-images" }, "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\nvalue. Use the limit parameter to make an initial limited request and\nuse the ID of the last-seen item from the response as the marker\nparameter 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\ninitial limited request and use the ID of the last-seen item from the\nresponse 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 name, as a string. A valid value is the name of\nan image." } }, { "name": "owner", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a project (also called a “tenant”) ID. Shows only\nimages that are shared with you by the specified owner." } }, { "name": "protected", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filters the response by the ‘protected’ image property. A valid value is\none of ‘true’, ‘false’ (must be all lowercase). Any other value will\nresult in a 400 response." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "integer", "description": "Filters the response by an image status." } }, { "name": "tag", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by the specified tag value. May be repeated, but keep\nin mind that you’re making a conjunctive query, so only images containing\nall the tags specified will appear in the response." } }, { "name": "visibility", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by an image visibility value. A valid value is\npublic, private, community, shared, or all. (Note\nthat if you filter on shared, the images included in the response\nwill only be those where your member status is accepted unless you\nexplicitly include a member_status filter in the request.) If you\nomit this parameter, the response shows public, private, and those\nshared images with a member status of accepted." } }, { "name": "os_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "description": "When true, filters the response to display only “hidden” images. By\ndefault, “hidden” images are not included in the image-list response.\n(Since Image API v2.7)" } }, { "name": "member_status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a member status. A valid value is accepted,\npending, rejected, or all. Default is accepted." } }, { "name": "size_max", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a maximum image size, in\nbytes." } }, { "name": "size_min", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a minimum image size, in\nbytes." } }, { "name": "created_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify a comparison filter based on the date and time when the resource\nwas created. (See Time Comparison Filters)." } }, { "name": "updated_at", "in": "query", "required": false, "schema": { "type": "string", "description": "Specify a comparison filter based on the date and time when the resource\nwas most recently modified. (See Time Comparison Filters)." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts the response by a set of one or more sort\ndirection and attribute (sort_key) combinations. A valid value\nfor the sort direction is asc (ascending) or desc\n(descending). If you omit the sort direction in a set, the default\nis desc." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts the response by an attribute, such as\nname, id, or updated_at. Default is created_at.\nThe API uses the natural sorting direction of the sort_key\nimage attribute." } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts the response by one or more attribute and sort direction\ncombinations. You can also set multiple sort keys and directions.\nDefault direction is desc." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Images" ] } }, "/v2/images/{image_id}": { "get": { "operationId": "showImage", "summary": "Show image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Images" ] }, "patch": { "operationId": "updateImage", "summary": "Update image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#update-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "requestBody": { "content": { "application/openstack-images-v2.1-json-patch": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "replace" ] }, "path": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Images" ] }, "delete": { "operationId": "deleteImage", "summary": "Delete image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Images" ] } }, "/v2/images/{image_id}/tasks": { "get": { "operationId": "showTasksAssociatedWithImage", "summary": "Show tasks associated with image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-tasks-associated-with-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Images" ] } }, "/v2/images/{image_id}/actions/deactivate": { "post": { "operationId": "deactivateImage", "summary": "Deactivate image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#deactivate-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Images" ] } }, "/v2/images/{image_id}/actions/reactivate": { "post": { "operationId": "reactivateImage", "summary": "Reactivate image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#reactivate-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Images" ] } }, "/v2/images/{image_id}/members": { "post": { "operationId": "createImageMember", "summary": "Create image member", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-image-member" }, "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": { "member": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Sharing" ] }, "get": { "operationId": "listImageMembers", "summary": "List image members", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-image-members" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Sharing" ] } }, "/v2/images/{image_id}/members/{member_id}": { "get": { "operationId": "showImageMemberDetails", "summary": "Show image member details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-member-details" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Sharing" ] }, "put": { "operationId": "updateImageMember", "summary": "Update image member", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#update-image-member" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } } } } } }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Sharing" ] }, "delete": { "operationId": "deleteImageMember", "summary": "Delete image member", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-member" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the image member. An image member is usually the project (also\ncalled the “tenant”) with whom the image is shared." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Sharing" ] } }, "/v2/images/{image_id}/tags/{tag}": { "put": { "operationId": "addImageTag", "summary": "Add image tag", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#add-image-tag" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "description": "The image tag. A tag is limited to 255 chars in length. You may wish\nto use characters that can easily be written in a URL." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Image tags" ] }, "delete": { "operationId": "deleteImageTag", "summary": "Delete image tag", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-tag" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "description": "The image tag. A tag is limited to 255 chars in length. You may wish\nto use characters that can easily be written in a URL." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Image tags" ] } }, "/v2/schemas/images": { "get": { "operationId": "showImagesSchema", "summary": "Show images schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-images-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Schemas" ] } }, "/v2/schemas/image": { "get": { "operationId": "showImageSchema", "summary": "Show image schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Schemas" ] } }, "/v2/schemas/members": { "get": { "operationId": "showImageMembersSchema", "summary": "Show image members schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-members-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Schemas" ] } }, "/v2/schemas/member": { "get": { "operationId": "showImageMemberSchema", "summary": "Show image member schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-image-member-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Schemas" ] } }, "/v2/images/{image_id}/file": { "put": { "operationId": "uploadBinaryImageData", "summary": "Upload binary image data", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#upload-binary-image-data" }, "parameters": [ { "name": "X-Image-Meta-Store", "in": "header", "required": false, "schema": { "type": "string", "description": "A store identifier to upload or import image data. Should only be included\nwhen making a request to a cloud that supports multiple backing stores. Use\nthe Store Discovery call to determine an\nappropriate store identifier. Simply omit this header to use the default\nstore. (Since Image API v2.8)" } }, { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Image data" ] }, "get": { "operationId": "downloadBinaryImageData", "summary": "Download binary image data", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#download-binary-image-data" }, "parameters": [ { "name": "Range", "in": "header", "required": false, "schema": { "type": "string", "description": "The range of image data requested. Note that multi range requests are\nnot supported. For details, see\nHypertext Transfer Protocol (HTTP/1.1): Range Requests." } }, { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image data" ] } }, "/v2/images/{image_id}/stage": { "put": { "operationId": "stageBinaryImageData", "summary": "Stage binary image data", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#stage-binary-image-data" }, "parameters": [ { "name": "Content-type", "in": "header", "required": true, "schema": { "type": "string", "description": "The media type descriptor for the request body. Use\napplication/octet-stream" } }, { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Interoperable image import" ] } }, "/v2/images/{image_id}/import": { "post": { "operationId": "importAnImage", "summary": "Import an image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#import-an-image" }, "parameters": [ { "name": "Content-type", "in": "header", "required": true, "schema": { "type": "string", "description": "The media type descriptor for the request body. Use\napplication/json." } }, { "name": "X-Image-Meta-Store", "in": "header", "required": false, "schema": { "type": "string", "description": "A store identifier to upload or import image data. Should only be included\nwhen making a request to a cloud that supports multiple backing stores. Use\nthe Store Discovery call to determine an\nappropriate store identifier. Simply omit this header to use the default\nstore. (Since Image API v2.8)" } }, { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "object", "properties": { "name": { "type": "string" } } }, "stores": { "type": "array", "items": { "type": "string" } }, "all_stores_must_succeed": { "type": "boolean" }, "all_stores": { "type": "boolean" } } } } } }, "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Interoperable image import" ] } }, "/v2/stores/{store_id}/{image_id}": { "delete": { "operationId": "deleteImageFromStore", "summary": "Delete image from store", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-from-store" }, "parameters": [ { "name": "store_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The ID of the store from which image is to be deleted." } }, { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Stores" ] } }, "/v2/info/import": { "get": { "operationId": "importMethodsAndValuesDiscovery", "summary": "Import methods and values discovery", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#import-methods-and-values-discovery" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Service Info (Discovery)" ] } }, "/v2/info/stores": { "get": { "operationId": "listStores", "summary": "List stores", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-stores" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Service Info (Discovery)" ] } }, "/v2/info/usage": { "get": { "operationId": "quotaUsage", "summary": "Quota usage", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#quota-usage" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Service Info (Discovery)" ] } }, "/v2/info/stores/detail": { "get": { "operationId": "listStoresDetail", "summary": "List stores detail", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-stores-detail" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Image Service Info (Discovery)" ] } }, "/v2/tasks": { "post": { "operationId": "createTask", "summary": "Create task", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#create-task" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string" }, "input": { "type": "object", "properties": { "import_from": { "type": "string" }, "import_from_format": { "type": "string" }, "image_properties": { "type": "object", "properties": { "disk_format": { "type": "string" }, "container_format": { "type": "string" } } } } } } } } } }, "responses": { "201": { "description": "Request was successful." } }, "tags": [ "Tasks" ] }, "get": { "operationId": "listTasks", "summary": "List tasks", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#list-tasks" }, "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\nvalue. Use the limit parameter to make an initial limited request and\nuse the ID of the last-seen item from the response as the marker\nparameter 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\ninitial limited request and use the ID of the last-seen item from the\nresponse as the marker parameter value in a subsequent limited request." } }, { "name": "sort_dir", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts the response by a set of one or more sort direction and attribute\n(sort_key) combinations. A valid value for the sort direction is\nasc (ascending) or desc (descending). If you omit the sort\ndirection in a set, the default is desc." } }, { "name": "sort_key", "in": "query", "required": false, "schema": { "type": "string", "description": "Sorts the response by one of the following attributes: created_at,\nexpires_at, status, type, updated_at. Default is\ncreated_at." } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a task status. A valid value is pending,\nprocessing, success, or failure." } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "description": "Filters the response by a task type. A valid value is import." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Tasks" ] } }, "/v2/tasks/{task_id}": { "get": { "operationId": "showTaskDetails", "summary": "Show task details", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-task-details" }, "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The identifier for the task, a UUID." } } ], "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Tasks" ] } }, "/v2/schemas/tasks": { "get": { "operationId": "showTasksSchema", "summary": "Show tasks schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-tasks-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Task Schemas" ] } }, "/v2/schemas/task": { "get": { "operationId": "showTaskSchema", "summary": "Show task schema", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#show-task-schema" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Task Schemas" ] } }, "/v2/cache": { "get": { "operationId": "queryCacheStatus", "summary": "Query cache status", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#query-cache-status" }, "responses": { "200": { "description": "Request was successful." } }, "tags": [ "Cache Manage" ] }, "delete": { "operationId": "clearImagesFromCache", "summary": "Clear images from cache", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#clear-images-from-cache" }, "parameters": [ { "name": "x-image-cache-clear-target", "in": "header", "required": false, "schema": { "type": "string", "description": "A keyword indicating ‘cache’, ‘queue’ or empty string to indicate the delete\nAPI to delete images from cache or queue or delete from both. If this header\nis missing then all cached and queued images for caching will be deleted." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Cache Manage" ] } }, "/v2/cache/{image_id}": { "put": { "operationId": "queueImage", "summary": "Queue image", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#queue-image" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Cache Manage" ] }, "delete": { "operationId": "deleteImageFromCache", "summary": "Delete image from cache", "externalDocs": { "url": "https://docs.openstack.org/api-ref/image/v2/index.html?expanded=#delete-image-from-cache" }, "parameters": [ { "name": "image_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The UUID of the image." } } ], "responses": { "204": { "description": "Request was successful." } }, "tags": [ "Cache Manage" ] } } }, "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 Image Service API v2", "url": "https://docs.openstack.org/api-ref/image/v2/index.html" } }