Metadata Definitions Service API v2 (CURRENT)

Show All

Metadefs

General information

The Metadata Definitions Service (“metadefs”, for short) provides a common API for vendors, operators, administrators, services, and users to meaningfully define available key:value pairs that can be used on different types of cloud resources (for example, images, artifacts, volumes, flavors, aggregates, and other resources).

To get you started, Glance contains a default catalog of metadefs that may be installed at your site; see the README in the code repository for details.

Once a common catalog of metadata definitions has been created, the catalog is available for querying through the API. Note that this service stores only the catalog, because metadefs are meta-metadata. Metadefs provide information about resource metadata, but do not themselves serve as actual metadata.

Actual key:value pairs are stored on the resources to which they apply using the metadata facilities provided by the appropriate API. (For example, the Images API would be used to put specific key:value pairs on a virtual machine image.)

A metadefs definition includes a property’s key, its description, its constraints, and the resource types to which it can be associated. See Metadata Definition Concepts in the Glance Developer documentation for more information.

Note

By default, only admins can manipulate the data exposed by this API, but all users may list and show public resources. This changed from a default of “open to all” in the Wallaby release.

Metadata definition namespaces

Creates, lists, shows details for, updates, and deletes metadata definition namespaces. Defines namespaces that can contain property definitions, object definitions, and resource type associations.

Since API v2.2

POST

/v2/metadefs/namespaces

Create namespace

detail

Creates a namespace.

A namespace must be unique across all users. Attempting to create an already existing namespace will result in a 409 (Conflict) response.

The Location response header contains the newly-created URI for the namespace.

Normal response codes: 201

Error response codes: 400, 401, 403, 409

Request

Name	In	Type	Description
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
description (Optional)	body	string	The description of the namespace.
visibility (Optional)	body	enum	The namespace visibility. A valid value is public or private. Default is private.
protected (Optional)	body	boolean	Namespace protection for deletion. A valid value is true or false. Default is false.

The request body may also contain properties, objects, and resource type associations, or these can be added later by the Update namespace call.

Request Example

{
    "namespace": "FredCo::SomeCategory::Example",
    "display_name": "An Example Namespace",
    "description": "A metadata definitions namespace for example use.",
    "visibility": "public",
    "protected": true
}

Response Parameters

Name	In	Type	Description
Location	header	string	The newly-created URI for the namespace.
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description (Optional)	body	string	The description of the namespace.
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
owner	body	string	An identifier for the owner of this resource, usually the tenant ID.
protected	body	boolean	Namespace protection for deletion, either true or false.
schema	body	string	The URI of the JSON schema describing a namespace.
self	body	string	The URI for this resource.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.
visibility	body	enum	The namespace visibility, either public or private.

If the request body contained properties, objects, or resource type associations, these will be included in the response.

Response Example

HTTP/1.1 201 Created
Content-Length: 427
Content-Type: application/json; charset=UTF-8
Location: http://glance.openstack.example.org/v2/metadefs/namespaces/FredCo::SomeCategory::Example
X-Openstack-Request-Id: req-6d4a8ad2-c018-4bfc-8fe5-1a36c23c43eb
Date: Thu, 19 May 2016 16:05:48 GMT

{
    "created_at": "2016-05-19T16:05:48Z",
    "description": "A metadata definitions namespace for example use.",
    "display_name": "An Example Namespace",
    "namespace": "FredCo::SomeCategory::Example",
    "owner": "c60b1d57c5034e0d86902aedf8c49be0",
    "protected": true,
    "schema": "/v2/schemas/metadefs/namespace",
    "self": "/v2/metadefs/namespaces/FredCo::SomeCategory::Example",
    "updated_at": "2016-05-19T16:05:48Z",
    "visibility": "public"
}

GET

/v2/metadefs/namespaces

List namespaces

detail

Lists available namespaces.

Returns a list of namespaces to which the authenticated user has access. If the list is too large to fit in a single response, either because of operator configuration or because you’ve included a limit query parameter in the request to restrict the response size, the response will contain a link that you can use to get the next page of namespaces. Check for the presence of a next link and use it as the URI in a subsequent HTTP GET request. Follow this pattern until a next link is no longer provided.

The next link preserves any query parameters that you send in your initial request. You can use the first link to return to the first page in the collection. If you prefer to paginate through namespaces manually, use the limit and marker parameters.

The list operation accepts the resource_types and visibility query parameters, which you can use to filter the response.

To sort the results of this operation, use the sort_key and sort_dir parameters. The API uses the natural sorting order in the namespace attribute that you provide as the sort_key parameter.

Normal response codes: 200

Error response codes: 401, 403, 404

Request

Name	In	Type	Description
limit (Optional)	query	integer	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.
marker (Optional)	query	string	Allows specification of a namespace identifier. When present, only namespaces occurring after that namespace will be listed, that is, those namespaces having a sort_key later than that of the marker in the sort_dir direction.
visibility (Optional)	query	string	Filters the response by a namespace visibility value. A valid value is public or private. If you omit this parameter, the response shows both public and private namespaces.
resource_types (Optional)	query	integer	Filters the response to include only those namespaces that contain the specified resource type or types as resource type associations. Use the comma (,) character to separate multiple values. For example, OS::Glance::Image,OS::Nova::Flavor shows only namespaces associated with these resource types.
sort_key (Optional)	query	string	Sorts the response by an attribute. Accepted values are namespace, created_at, and updated_at. Default is created_at.
sort_dir (Optional)	query	string	Sorts the response. Use asc for ascending or desc for descending order. The default is desc.

Response Parameters

Name	In	Type	Description
first	body	string	The URI for the first page of response.
namespaces	body	array	A list of namespace objects.
next	body	string	The URI for the next page of response. Will not be present on the last page of the response.
schema	body	string	The URI of the JSON schema describing a namespaces entity, that is, an entity consisting of a list of abbreviated namespace objects.

Response Example

{
    "first": "/v2/metadefs/namespaces?sort_key=created_at&sort_dir=asc",
    "namespaces": [
        {
            "created_at": "2014-08-28T17:13:06Z",
            "description": "The libvirt compute driver options. These are properties specific to compute drivers.  For a list of all hypervisors, see here: https://wiki.openstack.org/wiki/HypervisorSupportMatrix.",
            "display_name": "libvirt Driver Options",
            "namespace": "OS::Compute::Libvirt",
            "owner": "admin",
            "protected": true,
            "resource_type_associations": [
                {
                    "created_at": "2014-08-28T17:13:06Z",
                    "name": "OS::Glance::Image",
                    "updated_at": "2014-08-28T17:13:06Z"
                }
            ],
            "schema": "/v2/schemas/metadefs/namespace",
            "self": "/v2/metadefs/namespaces/OS::Compute::Libvirt",
            "updated_at": "2014-08-28T17:13:06Z",
            "visibility": "public"
        },
        {
            "created_at": "2014-08-28T17:13:06Z",
            "description": "Compute drivers may enable quotas on CPUs available to a VM, disk tuning, bandwidth I/O, and instance VIF traffic control.  See: http://docs.openstack.org/admin-guide-cloud/compute-flavors.html",
            "display_name": "Flavor Quota",
            "namespace": "OS::Compute::Quota",
            "owner": "admin",
            "protected": true,
            "resource_type_associations": [
                {
                    "created_at": "2014-08-28T17:13:06Z",
                    "name": "OS::Nova::Flavor",
                    "updated_at": "2014-08-28T17:13:06Z"
                }
            ],
            "schema": "/v2/schemas/metadefs/namespace",
            "self": "/v2/metadefs/namespaces/OS::Compute::Quota",
            "updated_at": "2014-08-28T17:13:06Z",
            "visibility": "public"
        },
        {
            "created_at": "2014-08-28T17:13:06Z",
            "description": "This provides the preferred socket/core/thread counts for the virtual CPU instance exposed to guests. This enables the ability to avoid hitting limitations on vCPU topologies that OS vendors place on their products. See also: https://opendev.org/openstack/nova-specs/src/branch/master/specs/juno/implemented/virt-driver-vcpu-topology.rst",
            "display_name": "Virtual CPU Topology",
            "namespace": "OS::Compute::VirtCPUTopology",
            "owner": "admin",
            "protected": true,
            "resource_type_associations": [
                {
                    "created_at": "2014-08-28T17:13:06Z",
                    "name": "OS::Glance::Image",
                    "prefix": "hw_",
                    "updated_at": "2014-08-28T17:13:06Z"
                },
                {
                    "created_at": "2014-08-28T17:13:06Z",
                    "name": "OS::Cinder::Volume",
                    "prefix": "hw_",
                    "properties_target": "image",
                    "updated_at": "2014-08-28T17:13:06Z"
                },
                {
                    "created_at": "2014-08-28T17:13:06Z",
                    "name": "OS::Nova::Flavor",
                    "prefix": "hw:",
                    "updated_at": "2014-08-28T17:13:06Z"
                }
            ],
            "schema": "/v2/schemas/metadefs/namespace",
            "self": "/v2/metadefs/namespaces/OS::Compute::VirtCPUTopology",
            "updated_at": "2014-08-28T17:13:06Z",
            "visibility": "public"
        }
    ],
    "schema": "/v2/schemas/metadefs/namespaces"
}

GET

/v2/metadefs/namespaces/{namespace_name}

Get namespace details

detail

Gets details for a namespace.

The response body shows a single namespace entity with all details including properties, objects, and resource type associations.

If the namespace contains a resource type association that specifies a prefix, you may optionally include the name of the resource type as a query parameter. In that case, the prefix will be applied to all property names in the response. (See below for an example.)

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
resource_type (Optional)	query	string	Apply the prefix for the specified resource type to the names of the properties listed in the response. If the resource type specified does not have an association with this namespace, or if the resource type is associated but does not have a prefix defined in this namespace, this parameter is ignored.

The request does not take a body.

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description (Optional)	body	string	The description of the namespace.
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
objects	body	string	One or more object definitions of the namespace.
owner	body	string	An identifier for the owner of this resource, usually the tenant ID.
properties	body	object	A dictionary of key:value pairs, where each value is a property object as defined by the Metadefs Property Schema.
protected	body	boolean	Namespace protection for deletion, either true or false.
resource_type_associations	body	array	A list, each element of which is described by the Metadefs Resource Type Association Schema.
schema	body	string	The URI of the JSON schema describing a namespace.
self	body	string	The URI for this resource.
visibility	body	enum	The namespace visibility, either public or private.

Response Example

{
    "created_at": "2016-06-28T14:57:10Z",
    "description": "The libvirt compute driver options.",
    "display_name": "libvirt Driver Options",
    "namespace": "OS::Compute::Libvirt",
    "owner": "admin",
    "properties": {
        "boot_menu": {
            "description": "If true, enables the BIOS bootmenu.",
            "enum": [
                "true",
                "false"
            ],
            "title": "Boot Menu",
            "type": "string"
        },
        "serial_port_count": {
            "description": "Specifies the count of serial ports.",
            "minimum": 0,
            "title": "Serial Port Count",
            "type": "integer"
        }
    },
    "protected": true,
    "resource_type_associations": [
        {
            "created_at": "2016-06-28T14:57:10Z",
            "name": "OS::Glance::Image",
            "prefix": "hw_"
        },
        {
            "created_at": "2016-06-28T14:57:10Z",
            "name": "OS::Nova::Flavor",
            "prefix": "hw:"
        }
    ],
    "schema": "/v2/schemas/metadefs/namespace",
    "self": "/v2/metadefs/namespaces/OS::Compute::Libvirt",
    "visibility": "public"
}

Response Example (with resource_type query parameter)

This is the result of the following request:

GET /v2/metadefs/namespaces/OS::Compute::Libvirt?resource_type=OS::Glance::Image

Note that the name of each property has had the appropriate prefix applied to it.

{
    "created_at": "2016-06-28T14:57:10Z",
    "description": "The libvirt compute driver options.",
    "display_name": "libvirt Driver Options",
    "namespace": "OS::Compute::Libvirt",
    "owner": "admin",
    "properties": {
        "hw_boot_menu": {
            "description": "If true, enables the BIOS bootmenu.",
            "enum": [
                "true",
                "false"
            ],
            "title": "Boot Menu",
            "type": "string"
        },
        "hw_serial_port_count": {
            "description": "Specifies the count of serial ports.",
            "minimum": 0,
            "title": "Serial Port Count",
            "type": "integer"
        }
    },
    "protected": true,
    "resource_type_associations": [
        {
            "created_at": "2016-06-28T14:57:10Z",
            "name": "OS::Glance::Image",
            "prefix": "hw_"
        },
        {
            "created_at": "2016-06-28T14:57:10Z",
            "name": "OS::Nova::Flavor",
            "prefix": "hw:"
        }
    ],
    "schema": "/v2/schemas/metadefs/namespace",
    "self": "/v2/metadefs/namespaces/OS::Compute::Libvirt",
    "visibility": "public"
}

PUT

/v2/metadefs/namespaces/{namespace_name}

Update namespace

detail

Updates a namespace.

Note

Be careful using this call, especially when all you want to do is change the protected value so that you can delete some objects, properties, or resource type associations in the namespace.

While only the namespace is required in the request body, if this call is made with only the namespace in request body, the other attributes listed below will be set to their default values – which in the case of description and display_name, is null.

So if you want to change only the protected value with this call, be sure to also include the current values of the following parameters in the request body:

• description

• display_name

• namespace

• visibility

The objects, properties, and resource type associations in a namespace are unaffected by this call.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
description (Optional)	body	string	The description of the namespace.
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
protected (Optional)	body	boolean	Namespace protection for deletion. A valid value is true or false. Default is false.
visibility (Optional)	body	enum	The namespace visibility. A valid value is public or private. Default is private.

Request Example

{
    "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the hardware specification required when a new vm is requested.",
    "display_name": "Hypervisor Selection",
    "namespace": "OS::Compute::Hypervisor",
    "protected": false,
    "visibility": "public"
}

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description (Optional)	body	string	The description of the namespace.
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
owner	body	string	An identifier for the owner of this resource, usually the tenant ID.
protected	body	boolean	Namespace protection for deletion, either true or false.
schema	body	string	The URI of the JSON schema describing a namespace.
self	body	string	The URI for this resource.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.
visibility	body	enum	The namespace visibility, either public or private.

Response Example

{
    "created_at": "2014-09-19T13:31:37Z",
    "description": "Choose capabilities that should be provided by the Compute Host. This provides the ability to fine tune the hardware specification required when a new vm is requested.",
    "display_name": "Hypervisor Selection",
    "namespace": "OS::Compute::Hypervisor",
    "owner": "7ec22942411e427692e8a3436be1031a",
    "protected": false,
    "schema": "/v2/schemas/metadefs/namespace",
    "self": "/v2/metadefs/namespaces/OS::Compute::Hypervisor",
    "updated_at": "2014-09-19T13:31:37Z",
    "visibility": "public"
}

DELETE

/v2/metadefs/namespaces/{namespace_name}

Delete namespace

detail

Deletes a namespace and its properties, objects, and any resource type associations.

Note

If the namespace is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to delete it.

• If you try to delete a protected namespace, the call returns the 403 response code.

• To change the protected attribute of a namespace, use the Update namespace call.

A successful operation returns the HTTP 204 (No Content) response code.

Normal response codes: 204

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

The request does not take a body.

The request does not return a body.

Metadata definition resource types

Lists resource types. Also, creates, lists, and removes resource type associations in a namespace.

Since API v2.2

GET

/v2/metadefs/resource_types

List resource types

detail

Lists all available resource types.

Using the other API calls in this section, you can create and maintain resource type associations between metadata definition namespaces and the resource types that are returned by this call.

Normal response codes: 200

Error response codes: 400, 401, 404

Request

There are no request parameters.

Response Parameters

Name	In	Type	Description
resource_types	body	array	A list of abbreviated resource type JSON objects, where each object contains the name of the resource type and its created_at and updated_at timestamps in ISO 8601 Format.

Response Example

{
    "resource_types": [
        {
            "created_at": "2014-08-28T18:13:04Z",
            "name": "OS::Glance::Image",
            "updated_at": "2014-08-28T18:13:04Z"
        },
        {
            "created_at": "2014-08-28T18:13:04Z",
            "name": "OS::Cinder::Volume",
            "updated_at": "2014-08-28T18:13:04Z"
        },
        {
            "created_at": "2014-08-28T18:13:04Z",
            "name": "OS::Nova::Flavor",
            "updated_at": "2014-08-28T18:13:04Z"
        },
        {
            "created_at": "2014-08-28T18:13:04Z",
            "name": "OS::Nova::Aggregate",
            "updated_at": "2014-08-28T18:13:04Z"
        },
        {
            "created_at": "2014-08-28T18:13:04Z",
            "name": "OS::Nova::Instance",
            "updated_at": "2014-08-28T18:13:04Z"
        }
    ]
}

POST

/v2/metadefs/namespaces/{namespace_name}/resource_types

Create resource type association

detail

Creates a resource type association between a namespace and the resource type specified in the body of the request.

Note

If the resource type name specified does not name an existing resource type, a new resource type will be created as a side effect of this operation.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.
prefix (Optional)	body	string	Prefix for any properties in the namespace that you want to apply to the resource type. If you specify a prefix, you must append a prefix separator, such as the colon (:) character.
properties_target (Optional)	body	string	Some resource types allow more than one key and value pair for each instance. For example, the Image service allows both user and image metadata on volumes. The properties_target parameter enables a namespace target to remove the ambiguity.

Request Example

{
    "name": "OS::Cinder::Volume",
    "prefix": "hw_",
    "properties_target": "image"
}

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
prefix (Optional)	body	string	Prefix for any properties in the namespace that you want to apply to the resource type. If you specify a prefix, you must append a prefix separator, such as the colon (:) character.
properties_target (Optional)	body	string	Some resource types allow more than one key and value pair for each instance. For example, the Image service allows both user and image metadata on volumes. The properties_target parameter enables a namespace target to remove the ambiguity.
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

GET

/v2/metadefs/namespaces/{namespace_name}/resource_types

List resource type associations

detail

Lists resource type associations in a namespace.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

There is no request body.

Response Parameters

Name	In	Type	Description
resource_type_associations	body	array	A list, each element of which is described by the Metadefs Resource Type Association Schema.

Response Example

{
    "resource_type_associations": [
        {
            "created_at": "2018-03-05T18:20:44Z",
            "name": "OS::Nova::Flavor",
            "prefix": "hw:"
        },
        {
            "created_at": "2018-03-05T18:20:44Z",
            "name": "OS::Glance::Image",
            "prefix": "hw_"
        }
    ]
}

DELETE

/v2/metadefs/namespaces/{namespace_name}/resource_types/{name}

Remove resource type association

detail

Removes a resource type association in a namespace.

Note

If the namespace containing the association is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to remove the resource type association.

• If you try to delete a resource type association from a protected namespace, the call returns the 403 response code.

• To change the protected attribute of a namespace, use the Update namespace call.

When you successfully delete a resource type association from a namespace, the response is empty and the response code is 204.

Normal response codes: 204

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
name	path	string	The name of the resource type.

Metadata definition objects

Creates, lists, shows details for, updates, and deletes metadata definition objects.

Since API v2.2

POST

/v2/metadefs/namespaces/{namespace_name}/objects

Create object

detail

Creates an object definition in a namespace.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
name	body	string	The name of the object, suitable for use as an identifier. A Name is limited to 80 chars in length.
description (Optional)	body	string	Detailed description of the object.
properties (Optional)	body	object	A set of key:value pairs, where each value is a property entity.
required (Optional)	body	array	A list of the names of properties that are required on this object.

Request Example

{
    "description": "You can configure the CPU limits with control parameters.",
    "name": "CPU Limits",
    "properties": {
        "quota:cpu_period": {
            "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.",
            "maximum": 1000000,
            "minimum": 1000,
            "title": "Quota: CPU Period",
            "type": "integer"
        },
        "quota:cpu_quota": {
            "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.",
            "title": "Quota: CPU Quota",
            "type": "integer"
        },
        "quota:cpu_shares": {
            "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
            "title": "Quota: CPU Shares",
            "type": "integer"
        }
    },
    "required": []
}

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description	body	string	Detailed description of the object.
name	body	string	The name of the object, suitable for use as an identifier. A Name is limited to 80 chars in length.
properties	body	object	A set of key:value pairs, where each value is a property entity.
required	body	array	A list of the names of properties that are required on this object.
schema	body	string	The URI of the JSON schema describing an object.
self	body	string	The URI for this resource.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2014-09-19T18:20:56Z",
    "description": "You can configure the CPU limits with control parameters.",
    "name": "CPU Limits",
    "properties": {
        "quota:cpu_period": {
            "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.",
            "maximum": 1000000,
            "minimum": 1000,
            "title": "Quota: CPU Period",
            "type": "integer"
        },
        "quota:cpu_quota": {
            "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.",
            "title": "Quota: CPU Quota",
            "type": "integer"
        },
        "quota:cpu_shares": {
            "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
            "title": "Quota: CPU Shares",
            "type": "integer"
        }
    },
    "required": [],
    "schema": "/v2/schemas/metadefs/object",
    "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits",
    "updated_at": "2014-09-19T18:20:56Z"
}

GET

/v2/metadefs/namespaces/{namespace_name}/objects

List objects

detail

Lists object definitions in a namespace.

Returns a subset of the larger collection of namespaces and a link that you can use to get the next set of namespaces. You should always check for the presence of a next link and use it as the URI in a subsequent HTTP GET request. You should follow this pattern until a next link is no longer provided. The next link preserves any query parameters that you send in your initial request. You can use the first link to jump back to the first page of the collection. If you prefer to paginate through namespaces manually, use the limit and marker parameters.

Use the resource_types and visibility query parameters to filter the response.

For example, set the resource_types query parameter to OS::Glance::Image,OS::Nova::Flavor to filter the response to include only namespaces that are associated with the given resource types.

You can sort the results of this operation by using the sort_key and sort_dir parameters. The API uses the natural sorting of whatever namespace attribute is provided as the sort_key.

Normal response codes: 200

Error response codes: 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
visibility (Optional)	query	string	Filters the response by a namespace visibility value. A valid value is public or private. If you omit this parameter, the response shows both public and private namespaces.
resource_types (Optional)	query	integer	Filters the response to include only those namespaces that contain the specified resource type or types as resource type associations. Use the comma (,) character to separate multiple values. For example, OS::Glance::Image,OS::Nova::Flavor shows only namespaces associated with these resource types.
sort_key (Optional)	query	string	Sorts the response by an attribute. Accepted values are namespace, created_at, and updated_at. Default is created_at.
sort_dir (Optional)	query	string	Sorts the response. Use asc for ascending or desc for descending order. The default is desc.

Response Parameters

Name	In	Type	Description
display_name (Optional)	body	string	User-friendly name to use in a UI to display the namespace name.
description (Optional)	body	string	The description of the namespace.
namespace	body	string	An identifier (a name) for the namespace. The value must be unique across all users.
visibility	body	enum	The namespace visibility, either public or private.
protected	body	boolean	Namespace protection for deletion, either true or false.
namespaces	body	array	A list of namespace objects.
resource_type_associations	body	array	A list, each element of which is described by the Metadefs Resource Type Association Schema.

Response Example

{
    "objects": [
        {
            "created_at": "2014-09-18T18:16:35Z",
            "description": "You can configure the CPU limits with control parameters.",
            "name": "CPU Limits",
            "properties": {
                "quota:cpu_period": {
                    "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.",
                    "maximum": 1000000,
                    "minimum": 1000,
                    "title": "Quota: CPU Period",
                    "type": "integer"
                },
                "quota:cpu_quota": {
                    "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.",
                    "title": "Quota: CPU Quota",
                    "type": "integer"
                },
                "quota:cpu_shares": {
                    "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
                    "title": "Quota: CPU Shares",
                    "type": "integer"
                }
            },
            "required": [],
            "schema": "/v2/schemas/metadefs/object",
            "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits"
        },
        {
            "created_at": "2014-09-18T18:16:35Z",
            "description": "Using disk I/O quotas, you can set maximum disk write to 10 MB per second for a VM user.",
            "name": "Disk QoS",
            "properties": {
                "quota:disk_read_bytes_sec": {
                    "description": "Sets disk I/O quota for disk read bytes / sec.",
                    "title": "Quota: Disk read bytes / sec",
                    "type": "integer"
                },
                "quota:disk_read_iops_sec": {
                    "description": "Sets disk I/O quota for disk read IOPS / sec.",
                    "title": "Quota: Disk read IOPS / sec",
                    "type": "integer"
                },
                "quota:disk_total_bytes_sec": {
                    "description": "Sets disk I/O quota for total disk bytes / sec.",
                    "title": "Quota: Disk Total Bytes / sec",
                    "type": "integer"
                },
                "quota:disk_total_iops_sec": {
                    "description": "Sets disk I/O quota for disk total IOPS / sec.",
                    "title": "Quota: Disk Total IOPS / sec",
                    "type": "integer"
                },
                "quota:disk_write_bytes_sec": {
                    "description": "Sets disk I/O quota for disk write bytes / sec.",
                    "title": "Quota: Disk Write Bytes / sec",
                    "type": "integer"
                },
                "quota:disk_write_iops_sec": {
                    "description": "Sets disk I/O quota for disk write IOPS / sec.",
                    "title": "Quota: Disk Write IOPS / sec",
                    "type": "integer"
                }
            },
            "required": [],
            "schema": "/v2/schemas/metadefs/object",
            "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/Disk QoS"
        },
        {
            "created_at": "2014-09-18T18:16:35Z",
            "description": "Bandwidth QoS tuning for instance virtual interfaces (VIFs) may be specified with these properties. Incoming and outgoing traffic can be shaped independently. If not specified, no quality of service (QoS) is applied on that traffic direction. So, if you want to shape only the network's incoming traffic, use inbound only (and vice versa). The OpenStack Networking service abstracts the physical implementation of the network, allowing plugins to configure and manage physical resources. Virtual Interfaces (VIF) in the logical model are analogous to physical network interface cards (NICs). VIFs are typically owned a managed by an external service; for instance when OpenStack Networking is used for building OpenStack networks, VIFs would be created, owned, and managed in Nova. VIFs are connected to OpenStack Networking networks via ports. A port is analogous to a port on a network switch, and it has an administrative state. When a VIF is attached to a port the OpenStack Networking API creates an attachment object, which specifies the fact that a VIF with a given identifier is plugged into the port.",
            "name": "Virtual Interface QoS",
            "properties": {
                "quota:vif_inbound_average": {
                    "description": "Network Virtual Interface (VIF) inbound average in kilobytes per second. Specifies average bit rate on the interface being shaped.",
                    "title": "Quota: VIF Inbound Average",
                    "type": "integer"
                },
                "quota:vif_inbound_burst": {
                    "description": "Network Virtual Interface (VIF) inbound burst in total kilobytes. Specifies the amount of bytes that can be burst at peak speed.",
                    "title": "Quota: VIF Inbound Burst",
                    "type": "integer"
                },
                "quota:vif_inbound_peak": {
                    "description": "Network Virtual Interface (VIF) inbound peak in kilobytes per second. Specifies maximum rate at which an interface can receive data.",
                    "title": "Quota: VIF Inbound Peak",
                    "type": "integer"
                },
                "quota:vif_outbound_average": {
                    "description": "Network Virtual Interface (VIF) outbound average in kilobytes per second. Specifies average bit rate on the interface being shaped.",
                    "title": "Quota: VIF Outbound Average",
                    "type": "integer"
                },
                "quota:vif_outbound_burst": {
                    "description": "Network Virtual Interface (VIF) outbound burst in total kilobytes. Specifies the amount of bytes that can be burst at peak speed.",
                    "title": "Quota: VIF Outbound Burst",
                    "type": "integer"
                },
                "quota:vif_outbound_peak": {
                    "description": "Network Virtual Interface (VIF) outbound peak in kilobytes per second. Specifies maximum rate at which an interface can send data.",
                    "title": "Quota: VIF Outbound Burst",
                    "type": "integer"
                }
            },
            "required": [],
            "schema": "/v2/schemas/metadefs/object",
            "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/Virtual Interface QoS"
        }
    ],
    "schema": "v2/schemas/metadefs/objects"
}

GET

/v2/metadefs/namespaces/{namespace_name}/objects/{object_name}

Show object

detail

Shows the definition for an object.

The response body shows a single object entity.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
object_name	path	string	The name of the object.

There is no request body.

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description	body	string	Detailed description of the object.
name	body	string	The name of the object, suitable for use as an identifier. A Name is limited to 80 chars in length.
properties	body	object	A set of key:value pairs, where each value is a property entity.
required	body	array	A list of the names of properties that are required on this object.
schema	body	string	The URI of the JSON schema describing an object.
self	body	string	The URI for this resource.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2014-09-19T18:20:56Z",
    "description": "You can configure the CPU limits with control parameters.",
    "name": "CPU Limits",
    "properties": {
        "quota:cpu_period": {
            "description": "Specifies the enforcement interval (unit: microseconds) for QEMU and LXC hypervisors. Within a period, each VCPU of the domain is not allowed to consume more than the quota worth of runtime. The value should be in range [1000, 1000000]. A period with value 0 means no value.",
            "maximum": 1000000,
            "minimum": 1000,
            "title": "Quota: CPU Period",
            "type": "integer"
        },
        "quota:cpu_quota": {
            "description": "Specifies the maximum allowed bandwidth (unit: microseconds). A domain with a negative-value quota indicates that the domain has infinite bandwidth, which means that it is not bandwidth controlled. The value should be in range [1000, 18446744073709551] or less than 0. A quota with value 0 means no value. You can use this feature to ensure that all vCPUs run at the same speed.",
            "title": "Quota: CPU Quota",
            "type": "integer"
        },
        "quota:cpu_shares": {
            "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
            "title": "Quota: CPU Shares",
            "type": "integer"
        }
    },
    "required": [],
    "schema": "/v2/schemas/metadefs/object",
    "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits",
    "updated_at": "2014-09-19T18:20:56Z"
}

PUT

/v2/metadefs/namespaces/{namespace_name}/objects/{object_name}

Update object

detail

Updates an object definition in a namespace.

The object resource is completely replaced by what you specify in the request body. Thus, if you leave out any of the optional parameters, and they exist in the current object, they will be eliminated by this call.

It is possible to change the name of the object with this call; if you do, note that the URL for the object (specified by the self field) will change.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
object_name	path	string	The name of the object.
name	body	string	The name of the object, suitable for use as an identifier. A Name is limited to 80 chars in length.
description (Optional)	body	string	Detailed description of the object.
properties (Optional)	body	object	A set of key:value pairs, where each value is a property entity.
required (Optional)	body	array	A list of the names of properties that are required on this object.

Request Example

{
    "description": "You can configure the CPU limits with control parameters.",
    "name": "CPU Limits",
    "properties": {
        "quota:cpu_shares": {
            "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
            "title": "Quota: CPU Shares",
            "type": "integer"
        }
    },
    "required": []
}

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
description	body	string	Detailed description of the object.
name	body	string	The name of the object, suitable for use as an identifier. A Name is limited to 80 chars in length.
properties	body	object	A set of key:value pairs, where each value is a property entity.
required	body	array	A list of the names of properties that are required on this object.
schema	body	string	The URI of the JSON schema describing an object.
self	body	string	The URI for this resource.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2014-09-19T19:20:56Z",
    "description": "You can configure the CPU limits with control parameters.",
    "name": "CPU Limits",
    "properties": {
        "quota:cpu_shares": {
            "description": "Specifies the proportional weighted share for the domain. If this element is omitted, the service defaults to the OS provided defaults. There is no unit for the value; it is a relative measure based on the setting of other VMs. For example, a VM configured with value 2048 gets twice as much CPU time as a VM configured with value 1024.",
            "title": "Quota: CPU Shares",
            "type": "integer"
        }
    },
    "required": [],
    "schema": "/v2/schemas/metadefs/object",
    "self": "/v2/metadefs/namespaces/OS::Compute::Quota/objects/CPU Limits",
    "updated_at": "2014-09-19T19:20:56Z"
}

DELETE

/v2/metadefs/namespaces/{namespace_name}/objects/{object_name}

Delete object

detail

Deletes an object definition from a namespace.

Note

If the namespace containing the object is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to delete the object.

• If you try to delete an object from a protected namespace, the call returns the 403 response code.

• To change the protected attribute of a namespace, use the Update namespace call.

When you successfully delete an object from a namespace, the response is empty and the response code is 204.

Normal response codes: 204

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
object_name	path	string	The name of the object.

There is no request body.

There is no response body.

Metadata definition properties

Creates, lists, shows details for, updates, and deletes metadata definition properties.

Since API v2.2

POST

/v2/metadefs/namespaces/{namespace_name}/properties

Create property

detail

Creates a property definition in a namespace.

The schema is a subset of the JSON property definition schema.

Normal response codes: 201

Error response codes: 400, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.
title	body	string	The title of the property.
type	body	string	The property type.
additionalItems (Optional)	body	string	Describes extra items, if you use tuple typing. If the value of items is an array (tuple typing) and the instance is longer than the list of schemas in items, the additional items are described by the schema in this property. If this value is false, the instance cannot be longer than the list of schemas in items. If this value is true, that is equivalent to the empty schema (anything goes).
description (Optional)	body	string	Detailed description of the property.
default (Optional)	body	string	Default property description.
items (Optional)	body	string	Schema for the items in an array.
operators (Optional)	body	string	Operators property description.
enum	body	array	Enumerated list of property values.
maximum (Optional)	body	string	Maximum allowed numerical value.
minItems (Optional)	body	string	Minimum length of an array.
readonly (Optional)	body	boolean	Indicates whether this is a read-only property.
minimum (Optional)	body	string	Minimum allowed numerical value.
maxItems (Optional)	body	string	Maximum length of an array.
maxLength (Optional)	body	string	Maximum allowed string length.
uniqueItems (Optional)	body	string	Indicates whether all values in the array must be distinct.
pattern (Optional)	body	string	A regular expression ( ECMA 262 ) that a string value must match.
minLength (Optional)	body	string	Minimum allowed string length.

Request Example

{
    "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.",
    "enum": [
        "xen",
        "qemu",
        "kvm",
        "lxc",
        "uml",
        "vmware",
        "hyperv"
    ],
    "name": "hypervisor_type",
    "title": "Hypervisor Type",
    "type": "string"
}

Response Parameters

Name	In	Type	Description
additionalItems (Optional)	body	string	Describes extra items, if you use tuple typing. If the value of items is an array (tuple typing) and the instance is longer than the list of schemas in items, the additional items are described by the schema in this property. If this value is false, the instance cannot be longer than the list of schemas in items. If this value is true, that is equivalent to the empty schema (anything goes).
description	body	string	Detailed description of the property.
title	body	string	The title of the property.
default (Optional)	body	string	Default property description.
items (Optional)	body	string	Schema for the items in an array.
operators (Optional)	body	string	Operators property description.
enum	body	array	Enumerated list of property values.
maximum (Optional)	body	string	Maximum allowed numerical value.
minItems (Optional)	body	string	Minimum length of an array.
readonly (Optional)	body	boolean	Indicates whether this is a read-only property.
minimum (Optional)	body	string	Minimum allowed numerical value.
maxItems (Optional)	body	string	Maximum length of an array.
maxLength (Optional)	body	string	Maximum allowed string length.
uniqueItems (Optional)	body	string	Indicates whether all values in the array must be distinct.
pattern (Optional)	body	string	A regular expression ( ECMA 262 ) that a string value must match.
type	body	string	The property type.
minLength (Optional)	body	string	Minimum allowed string length.
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.

Response Example

{
    "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.",
    "enum": [
        "xen",
        "qemu",
        "kvm",
        "lxc",
        "uml",
        "vmware",
        "hyperv"
    ],
    "name": "hypervisor_type",
    "title": "Hypervisor Type",
    "type": "string"
}

GET

/v2/metadefs/namespaces/{namespace_name}/properties

List properties

detail

Lists property definitions in a namespace.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

There is no request body.

Response Parameters

Name	In	Type	Description
properties	body	object	A dictionary of key:value pairs, where each value is a property object as defined by the Metadefs Property Schema.

Response Example

{
    "properties": {
        "hw_disk_bus": {
            "description": "Specifies the type of disk controller to attach disk devices to.",
            "enum": [
                "scsi",
                "virtio",
                "uml",
                "xen",
                "ide",
                "usb",
                "fdc",
                "sata"
            ],
            "title": "Disk Bus",
            "type": "string"
        },
        "hw_machine_type": {
            "description": "Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).",
            "title": "Machine Type",
            "type": "string"
        },
        "hw_qemu_guest_agent": {
            "description": "It is a daemon program running inside the domain which is supposed to help management applications with executing functions which need assistance of the guest OS. For example, freezing and thawing filesystems, entering suspend. However, guest agent (GA) is not bullet proof, and hostile guest OS can send spurious replies.",
            "enum": [
                "yes",
                "no"
            ],
            "title": "QEMU Guest Agent",
            "type": "string"
        },
        "hw_rng_model": {
            "default": "virtio",
            "description": "Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default: The generator device is disabled. /dev/random is used as the default entropy source. To specify a physical HW RNG device, use the following option in the nova.conf file: rng_dev_path=/dev/hwrng",
            "title": "Random Number Generator Device",
            "type": "string"
        },
        "hw_scsi_model": {
            "default": "virtio-scsi",
            "description": "Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI controller device that provides improved scalability and performance, and supports advanced SCSI hardware.",
            "title": "SCSI Model",
            "type": "string"
        },
        "hw_video_model": {
            "description": "The video image driver used.",
            "enum": [
                "vga",
                "cirrus",
                "vmvga",
                "xen",
                "qxl"
            ],
            "title": "Video Model",
            "type": "string"
        },
        "hw_video_ram": {
            "description": "Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram.",
            "title": "Max Video Ram",
            "type": "integer"
        },
        "hw_vif_model": {
            "description": "Specifies the model of virtual network interface device to use. The valid options depend on the configured hypervisor. KVM and QEMU: e1000, ne2k_pci, pcnet, rtl8139, virtio, e1000e and vmxnet3. VMware: e1000, e1000e, VirtualE1000, VirtualE1000e, VirtualPCNet32,  and VirtualVmxnet. Xen: e1000, netfront, ne2k_pci, pcnet, and rtl8139.",
            "enum": [
                "e1000",
                "ne2k_pci",
                "pcnet",
                "rtl8139",
                "virtio",
                "e1000e",
                "vmxnet3",
                "VirtualE1000",
                "VirtualE1000e",
                "VirtualPCNet32",
                "VirtualVmxnet",
                "netfront",
                "ne2k_pci"
            ],
            "title": "Virtual Network Interface",
            "type": "string"
        },
        "os_command_line": {
            "description": "The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).",
            "title": "Kernel Command Line",
            "type": "string"
        }
    }
}

GET

/v2/metadefs/namespaces/{namespace_name}/properties/{property_name}

Show property definition

detail

Shows the definition for a property.

If you use the resource_type query parameter, the API removes the prefix of the resource type from the property name before it submits the query. This enables you to look for a property name that starts with a prefix from an associated resource type.

The response body shows a single property entity.

Normal response codes: 200

Error response codes: 401, 403, 404

Request

Name	In	Type	Description
property_name	path	string	The name of the property.
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
resource_type (Optional)	query	string	Filters the response by property names that start with a prefix from an associated resource type. The API removes the prefix of the resource type from the property name in the response.

Response Parameters

Name	In	Type	Description
additionalItems (Optional)	body	string	Describes extra items, if you use tuple typing. If the value of items is an array (tuple typing) and the instance is longer than the list of schemas in items, the additional items are described by the schema in this property. If this value is false, the instance cannot be longer than the list of schemas in items. If this value is true, that is equivalent to the empty schema (anything goes).
description	body	string	Detailed description of the property.
title	body	string	The title of the property.
default (Optional)	body	string	Default property description.
items (Optional)	body	string	Schema for the items in an array.
operators (Optional)	body	string	Operators property description.
enum	body	array	Enumerated list of property values.
maximum (Optional)	body	string	Maximum allowed numerical value.
minItems (Optional)	body	string	Minimum length of an array.
readonly (Optional)	body	boolean	Indicates whether this is a read-only property.
minimum (Optional)	body	string	Minimum allowed numerical value.
maxItems (Optional)	body	string	Maximum length of an array.
maxLength (Optional)	body	string	Maximum allowed string length.
uniqueItems (Optional)	body	string	Indicates whether all values in the array must be distinct.
pattern (Optional)	body	string	A regular expression ( ECMA 262 ) that a string value must match.
type	body	string	The property type.
minLength (Optional)	body	string	Minimum allowed string length.
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.

Response Example

{
    "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.",
    "enum": [
        "xen",
        "qemu",
        "kvm",
        "lxc",
        "uml",
        "vmware",
        "hyperv"
    ],
    "name": "hypervisor_type",
    "title": "Hypervisor Type",
    "type": "string"
}

PUT

/v2/metadefs/namespaces/{namespace_name}/properties/{property_name}

Update property definition

detail

Updates a property definition.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
property_name	path	string	The name of the property.
name	body	string	The name of the property. A Name is limited to 80 chars in length.
title	body	string	The title of the property.
type	body	string	The property type.
additionalItems (Optional)	body	string	Describes extra items, if you use tuple typing. If the value of items is an array (tuple typing) and the instance is longer than the list of schemas in items, the additional items are described by the schema in this property. If this value is false, the instance cannot be longer than the list of schemas in items. If this value is true, that is equivalent to the empty schema (anything goes).
description (Optional)	body	string	The description of the namespace.
default (Optional)	body	string	Default property description.
items (Optional)	body	string	Schema for the items in an array.
operators (Optional)	body	string	Operators property description.
enum	body	array	Enumerated list of property values.
maximum (Optional)	body	string	Maximum allowed numerical value.
minItems (Optional)	body	string	Minimum length of an array.
readonly (Optional)	body	boolean	Indicates whether this is a read-only property.
minimum (Optional)	body	string	Minimum allowed numerical value.
maxItems (Optional)	body	string	Maximum length of an array.
maxLength (Optional)	body	string	Maximum allowed string length.
uniqueItems (Optional)	body	string	Indicates whether all values in the array must be distinct.
pattern (Optional)	body	string	A regular expression ( ECMA 262 ) that a string value must match.
minLength (Optional)	body	string	Minimum allowed string length.

Request Example

{
    "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.",
    "enum": [
        "xen",
        "qemu",
        "kvm",
        "lxc",
        "uml",
        "vmware",
        "hyperv"
    ],
    "name": "hypervisor_type",
    "title": "Hypervisor Type",
    "type": "string"
}

Response Parameters

Name	In	Type	Description
additionalItems (Optional)	body	string	Describes extra items, if you use tuple typing. If the value of items is an array (tuple typing) and the instance is longer than the list of schemas in items, the additional items are described by the schema in this property. If this value is false, the instance cannot be longer than the list of schemas in items. If this value is true, that is equivalent to the empty schema (anything goes).
description (Optional)	body	string	The description of the namespace.
title	body	string	The title of the property.
default (Optional)	body	string	Default property description.
items (Optional)	body	string	Schema for the items in an array.
operators (Optional)	body	string	Operators property description.
enum	body	array	Enumerated list of property values.
maximum (Optional)	body	string	Maximum allowed numerical value.
minItems (Optional)	body	string	Minimum length of an array.
readonly (Optional)	body	boolean	Indicates whether this is a read-only property.
minimum (Optional)	body	string	Minimum allowed numerical value.
maxItems (Optional)	body	string	Maximum length of an array.
maxLength (Optional)	body	string	Maximum allowed string length.
uniqueItems (Optional)	body	string	Indicates whether all values in the array must be distinct.
pattern (Optional)	body	string	A regular expression ( ECMA 262 ) that a string value must match.
type	body	string	The property type.
minLength (Optional)	body	string	Minimum allowed string length.
name	body	string	The name of the property. A Name is limited to 80 chars in length.

Response Example

{
    "description": "The hypervisor type. It may be used by the host properties filter for scheduling. The ImagePropertiesFilter filters compute nodes that satisfy any architecture, hypervisor type, or virtual machine mode properties specified on the instance's image properties. Image properties are contained in the image dictionary in the request_spec.",
    "enum": [
        "xen",
        "qemu",
        "kvm",
        "lxc",
        "uml",
        "vmware",
        "hyperv"
    ],
    "name": "hypervisor_type",
    "title": "Hypervisor Type",
    "type": "string"
}

DELETE

/v2/metadefs/namespaces/{namespace_name}/properties/{property_name}

Remove property definition

detail

Removes a property definition from a namespace.

Note

If the namespace containing the property is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to delete the property.

• If you try to delete a property from a protected namespace, the call returns the 403 response code.

• To change the protected attribute of a namespace, use the Update namespace call.

When you successfully delete a property from a namespace, the response is empty and the response code is 204.

Normal response codes: 204

Error response codes: 401, 403, 404

Request

Name	In	Type	Description
property_name	path	string	The name of the property.
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

Metadata definition tags

Creates, lists, shows details for, updates, and deletes metadata definition tags.

Since API v2.2

POST

/v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}

Create tag definition

detail

Adds a tag to the list of namespace tag definitions.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
tag_name	path	string	The name of the tag. A Name is limited to 80 chars in length.

There is no request body.

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
name	body	string	The name of the tag. A Name is limited to 80 chars in length.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2015-05-09T01:12:31Z",
    "name": "added-sample-tag",
    "updated_at": "2015-05-09T01:12:31Z"
}

GET

/v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}

Get tag definition

detail

Gets a definition for a tag.

The response body shows a single tag entity.

Normal response codes: 200

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
tag_name	path	string	The name of the tag. A Name is limited to 80 chars in length.
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

There is no request body.

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
name	body	string	The name of the tag. A Name is limited to 80 chars in length.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2015-05-06T23:16:12Z",
    "name": "sample-tag2",
    "updated_at": "2015-05-06T23:16:12Z"
}

PUT

/v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}

Update tag definition

detail

Renames a tag definition.

Normal response codes: 200

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
tag_name	path	string	The name of the tag. A Name is limited to 80 chars in length.
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
name	body	string	The name of the tag. A Name is limited to 80 chars in length.

Request Example

{
    "name": "new-tag-name"
}

Response Parameters

Name	In	Type	Description
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601.
name	body	string	The name of the tag. A Name is limited to 80 chars in length.
updated_at	body	string	The date and time when the resource was last updated. The date and time stamp format is ISO 8601.

Response Example

{
    "created_at": "2016-05-21T18:49:38Z",
    "name": "new-tag-name",
    "updated_at": "2016-05-21T19:04:22Z"
}

DELETE

/v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}

Delete tag definition

detail

Deletes a tag definition within a namespace.

Note

If the namespace containing the tag is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to delete the tag.

• If you try to delete a tag from a protected namespace, the call returns the 403 response code.

• To change the protected attribute of a namespace, use the Update namespace call.

When you successfully delete a tag from a namespace, the response is empty and the response code is 204.

Normal response codes: 204

Error response codes: 400, 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
tag_name	path	string	The name of the tag. A Name is limited to 80 chars in length.

POST

/v2/metadefs/namespaces/{namespace_name}/tags

Create tags

detail

Creates one or more tag definitions in a namespace.

Normal response codes: 201

Error response codes: 400, 401, 403, 404, 409

Request

Name	In	Type	Description
X-Openstack-Append (Optional)	header	string	If present and set to True, new metadefs tags are appended to the existing ones. Otherwise, existing tags are overwritten.
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
tags	body	array	A list of tag objects, where each object is defined by the Metadefs Tag Schema.

Request Example

{
    "tags": [
        {
            "name": "sample-tag1"
        },
        {
            "name": "sample-tag2"
        },
        {
            "name": "sample-tag3"
        }
    ]
}

Response Parameters

Name	In	Type	Description
name	path	string	Name of the resource type. A Name is limited to 80 chars in length.
tags	body	array	A list of tag objects, where each object is defined by the Metadefs Tag Schema.

Response Example

{
    "tags": [
        {
            "name": "sample-tag1"
        },
        {
            "name": "sample-tag2"
        },
        {
            "name": "sample-tag3"
        }
    ]
}

GET

/v2/metadefs/namespaces/{namespace_name}/tags

List tags

detail

Lists the tag definitions within a namespace.

To manually paginate through the list of tags, use the limit and marker parameters.

To sort the results of this operation use the sort_key and sort_dir parameters. The API uses the natural sort order of the tag attribute of the sort_key parameter.

Normal response codes: 200

Error response codes: 401, 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)
limit (Optional)	query	integer	Requests a page size of tags. Returns a number of tags up to a limit value. Use the limit parameter to make an initial limited request and use the name of the last-seen tag from the response as the marker parameter value in a subsequent limited request.
marker (Optional)	query	string	Allows specification of a tag name. When present, only tags occurring after the named tag will be listed, that is, those namespaces having a sort_key later than that of the marker in the sort_dir direction.
sort_key (Optional)	query	string	Sorts the response by an attribute. Accepted values are name, created_at, and updated_at. Default is created_at.
sort_dir (Optional)	query	string	Sorts the response. Use asc for ascending or desc for descending order. The default is desc.

There is no request body.

Response Parameters

Name	In	Type	Description
tags	body	array	A list of tag objects, where each object is defined by the Metadefs Tag Schema.

Response Example

{
    "tags": [
        {
            "name": "sample-tag1"
        },
        {
            "name": "sample-tag2"
        },
        {
            "name": "sample-tag3"
        }
    ]
}

DELETE

/v2/metadefs/namespaces/{namespace_name}/tags

Delete all tag definitions

detail

Deletes all tag definitions within a namespace.

Note

If the namespace containing the tags is protected, that is, if the protected attribute of the namespace is true, then you must first set the protected attribute to false on the namespace before you will be permitted to delete the tags. If you try to delete the tags from a protected namespace, the call returns the 403 response code.

When you successfully delete the tags from a namespace, the response is empty and the response code is 204.

Normal response codes: 204

Error response codes: 403, 404

Request

Name	In	Type	Description
namespace_name	path	string	The name of the namespace whose details you want to see. (The name is the value of a namespace’s namespace field.)

There is no request body.

There is no response body.

Metadata definition schemas

Gets a JSON-schema document that represents a metadata definition entity.

(Since API v2.2)

GET

/v2/schemas/metadefs/namespace

Show metadata definition namespace schema

detail

Shows a JSON schema document that represents a metadata definition namespace entity.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "additionalProperties": false,
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "property": {
            "additionalProperties": {
                "properties": {
                    "additionalItems": {
                        "type": "boolean"
                    },
                    "default": {},
                    "description": {
                        "type": "string"
                    },
                    "enum": {
                        "type": "array"
                    },
                    "items": {
                        "properties": {
                            "enum": {
                                "type": "array"
                            },
                            "type": {
                                "enum": [
                                    "array",
                                    "boolean",
                                    "integer",
                                    "number",
                                    "object",
                                    "string",
                                    null
                                ],
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "maxItems": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maxLength": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maximum": {
                        "type": "number"
                    },
                    "minItems": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minLength": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minimum": {
                        "type": "number"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "operators": {
                        "items": {
                            "type": "string"
                        },
                        "type": "array"
                    },
                    "pattern": {
                        "format": "regex",
                        "type": "string"
                    },
                    "readonly": {
                        "type": "boolean"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "enum": [
                            "array",
                            "boolean",
                            "integer",
                            "number",
                            "object",
                            "string",
                            null
                        ],
                        "type": "string"
                    },
                    "uniqueItems": {
                        "default": false,
                        "type": "boolean"
                    }
                },
                "required": [
                    "title",
                    "type"
                ],
                "type": "object"
            },
            "type": "object"
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true
        }
    },
    "name": "namespace",
    "properties": {
        "created_at": {
            "description": "Date and time of namespace creation",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "description": "Provides a user friendly description of the namespace.",
            "maxLength": 500,
            "type": "string"
        },
        "display_name": {
            "description": "The user friendly name for the namespace. Used by UI if available.",
            "maxLength": 80,
            "type": "string"
        },
        "namespace": {
            "description": "The unique namespace text.",
            "maxLength": 80,
            "type": "string"
        },
        "objects": {
            "items": {
                "properties": {
                    "description": {
                        "type": "string"
                    },
                    "name": {
                        "type": "string"
                    },
                    "properties": {
                        "$ref": "#/definitions/property"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    }
                },
                "type": "object"
            },
            "type": "array"
        },
        "owner": {
            "description": "Owner of the namespace.",
            "maxLength": 255,
            "type": "string"
        },
        "properties": {
            "$ref": "#/definitions/property"
        },
        "protected": {
            "description": "If true, namespace will not be deletable.",
            "type": "boolean"
        },
        "resource_type_associations": {
            "items": {
                "properties": {
                    "name": {
                        "type": "string"
                    },
                    "prefix": {
                        "type": "string"
                    },
                    "properties_target": {
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "type": "array"
        },
        "schema": {
            "readOnly": true,
            "type": "string"
        },
        "self": {
            "readOnly": true,
            "type": "string"
        },
        "tags": {
            "items": {
                "properties": {
                    "name": {
                        "type": "string"
                    }
                },
                "type": "object"
            },
            "type": "array"
        },
        "updated_at": {
            "description": "Date and time of the last namespace modification",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "visibility": {
            "description": "Scope of namespace accessibility.",
            "enum": [
                "public",
                "private"
            ],
            "type": "string"
        }
    },
    "required": [
        "namespace"
    ]
}

GET

/v2/schemas/metadefs/namespaces

Show metadata definition namespaces schema

detail

Shows a JSON schema document that represents a metadata definition namespaces entity.

A namespaces entity is a container for namespace entities.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "property": {
            "additionalProperties": {
                "properties": {
                    "additionalItems": {
                        "type": "boolean"
                    },
                    "default": {},
                    "description": {
                        "type": "string"
                    },
                    "enum": {
                        "type": "array"
                    },
                    "items": {
                        "properties": {
                            "enum": {
                                "type": "array"
                            },
                            "type": {
                                "enum": [
                                    "array",
                                    "boolean",
                                    "integer",
                                    "number",
                                    "object",
                                    "string",
                                    null
                                ],
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "maxItems": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maxLength": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maximum": {
                        "type": "number"
                    },
                    "minItems": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minLength": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minimum": {
                        "type": "number"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "operators": {
                        "items": {
                            "type": "string"
                        },
                        "type": "array"
                    },
                    "pattern": {
                        "format": "regex",
                        "type": "string"
                    },
                    "readonly": {
                        "type": "boolean"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "enum": [
                            "array",
                            "boolean",
                            "integer",
                            "number",
                            "object",
                            "string",
                            null
                        ],
                        "type": "string"
                    },
                    "uniqueItems": {
                        "default": false,
                        "type": "boolean"
                    }
                },
                "required": [
                    "title",
                    "type"
                ],
                "type": "object"
            },
            "type": "object"
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true
        }
    },
    "links": [
        {
            "href": "{first}",
            "rel": "first"
        },
        {
            "href": "{next}",
            "rel": "next"
        },
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "name": "namespaces",
    "properties": {
        "first": {
            "type": "string"
        },
        "namespaces": {
            "items": {
                "additionalProperties": false,
                "name": "namespace",
                "properties": {
                    "created_at": {
                        "description": "Date and time of namespace creation",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "description": {
                        "description": "Provides a user friendly description of the namespace.",
                        "maxLength": 500,
                        "type": "string"
                    },
                    "display_name": {
                        "description": "The user friendly name for the namespace. Used by UI if available.",
                        "maxLength": 80,
                        "type": "string"
                    },
                    "namespace": {
                        "description": "The unique namespace text.",
                        "maxLength": 80,
                        "type": "string"
                    },
                    "objects": {
                        "items": {
                            "properties": {
                                "description": {
                                    "type": "string"
                                },
                                "name": {
                                    "type": "string"
                                },
                                "properties": {
                                    "$ref": "#/definitions/property"
                                },
                                "required": {
                                    "$ref": "#/definitions/stringArray"
                                }
                            },
                            "type": "object"
                        },
                        "type": "array"
                    },
                    "owner": {
                        "description": "Owner of the namespace.",
                        "maxLength": 255,
                        "type": "string"
                    },
                    "properties": {
                        "$ref": "#/definitions/property"
                    },
                    "protected": {
                        "description": "If true, namespace will not be deletable.",
                        "type": "boolean"
                    },
                    "resource_type_associations": {
                        "items": {
                            "properties": {
                                "name": {
                                    "type": "string"
                                },
                                "prefix": {
                                    "type": "string"
                                },
                                "properties_target": {
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        },
                        "type": "array"
                    },
                    "schema": {
                        "readOnly": true,
                        "type": "string"
                    },
                    "self": {
                        "readOnly": true,
                        "type": "string"
                    },
                    "tags": {
                        "items": {
                            "properties": {
                                "name": {
                                    "type": "string"
                                }
                            },
                            "type": "object"
                        },
                        "type": "array"
                    },
                    "updated_at": {
                        "description": "Date and time of the last namespace modification",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "visibility": {
                        "description": "Scope of namespace accessibility.",
                        "enum": [
                            "public",
                            "private"
                        ],
                        "type": "string"
                    }
                },
                "required": [
                    "namespace"
                ]
            },
            "type": "array"
        },
        "next": {
            "type": "string"
        },
        "schema": {
            "type": "string"
        }
    }
}

GET

/v2/schemas/metadefs/resource_type

Show metadata definition namespace resource type association schema

detail

Shows a JSON schema document that represents a metadata definition namespace resource type association entity.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "additionalProperties": false,
    "name": "resource_type_association",
    "properties": {
        "created_at": {
            "description": "Date and time of resource type association",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "name": {
            "description": "Resource type names should be aligned with Heat resource types whenever possible: https://docs.openstack.org/heat/latest/template_guide/openstack.html",
            "maxLength": 80,
            "type": "string"
        },
        "prefix": {
            "description": "Specifies the prefix to use for the given resource type. Any properties in the namespace should be prefixed with this prefix when being applied to the specified resource type. Must include prefix separator (e.g. a colon :).",
            "maxLength": 80,
            "type": "string"
        },
        "properties_target": {
            "description": "Some resource types allow more than one key / value pair per instance.  For example, Cinder allows user and image metadata on volumes. Only the image properties metadata is evaluated by Nova (scheduling or drivers). This property allows a namespace target to remove the ambiguity.",
            "maxLength": 80,
            "type": "string"
        },
        "updated_at": {
            "description": "Date and time of the last resource type association modification",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "name"
    ]
}

GET

/v2/schemas/metadefs/resource_types

Show metadata definition namespace resource type associations schema

detail

Shows a JSON schema document that represents a metadata definition namespace resource type associations entity.

A resource type associations entity is a container for resource type association entities.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "links": [
        {
            "href": "{first}",
            "rel": "first"
        },
        {
            "href": "{next}",
            "rel": "next"
        },
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "name": "resource_type_associations",
    "properties": {
        "first": {
            "type": "string"
        },
        "next": {
            "type": "string"
        },
        "resource_type_associations": {
            "items": {
                "additionalProperties": false,
                "name": "resource_type_association",
                "properties": {
                    "created_at": {
                        "description": "Date and time of resource type association",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "name": {
                        "description": "Resource type names should be aligned with Heat resource types whenever possible: https://docs.openstack.org/heat/latest/template_guide/openstack.html",
                        "maxLength": 80,
                        "type": "string"
                    },
                    "prefix": {
                        "description": "Specifies the prefix to use for the given resource type. Any properties in the namespace should be prefixed with this prefix when being applied to the specified resource type. Must include prefix separator (e.g. a colon :).",
                        "maxLength": 80,
                        "type": "string"
                    },
                    "properties_target": {
                        "description": "Some resource types allow more than one key / value pair per instance.  For example, Cinder allows user and image metadata on volumes. Only the image properties metadata is evaluated by Nova (scheduling or drivers). This property allows a namespace target to remove the ambiguity.",
                        "maxLength": 80,
                        "type": "string"
                    },
                    "updated_at": {
                        "description": "Date and time of the last resource type association modification",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "required": [
                    "name"
                ]
            },
            "type": "array"
        },
        "schema": {
            "type": "string"
        }
    }
}

GET

/v2/schemas/metadefs/object

Show metadata definition object schema

detail

Shows a JSON schema document that represents a metadata definition object entity.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "additionalProperties": false,
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "property": {
            "additionalProperties": {
                "properties": {
                    "additionalItems": {
                        "type": "boolean"
                    },
                    "default": {},
                    "description": {
                        "type": "string"
                    },
                    "enum": {
                        "type": "array"
                    },
                    "items": {
                        "properties": {
                            "enum": {
                                "type": "array"
                            },
                            "type": {
                                "enum": [
                                    "array",
                                    "boolean",
                                    "integer",
                                    "number",
                                    "object",
                                    "string",
                                    null
                                ],
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "maxItems": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maxLength": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maximum": {
                        "type": "number"
                    },
                    "minItems": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minLength": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minimum": {
                        "type": "number"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "operators": {
                        "items": {
                            "type": "string"
                        },
                        "type": "array"
                    },
                    "pattern": {
                        "format": "regex",
                        "type": "string"
                    },
                    "readonly": {
                        "type": "boolean"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "enum": [
                            "array",
                            "boolean",
                            "integer",
                            "number",
                            "object",
                            "string",
                            null
                        ],
                        "type": "string"
                    },
                    "uniqueItems": {
                        "default": false,
                        "type": "boolean"
                    }
                },
                "required": [
                    "title",
                    "type"
                ],
                "type": "object"
            },
            "type": "object"
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true
        }
    },
    "name": "object",
    "properties": {
        "created_at": {
            "description": "Date and time of object creation",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "description": {
            "type": "string"
        },
        "name": {
            "maxLength": 255,
            "type": "string"
        },
        "properties": {
            "$ref": "#/definitions/property"
        },
        "required": {
            "$ref": "#/definitions/stringArray"
        },
        "schema": {
            "readOnly": true,
            "type": "string"
        },
        "self": {
            "readOnly": true,
            "type": "string"
        },
        "updated_at": {
            "description": "Date and time of the last object modification",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "name"
    ]
}

GET

/v2/schemas/metadefs/objects

Show metadata definition objects schema

detail

Shows a JSON schema document that represents a metadata definition objects entity.

An objects entity is a container for object entities.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "property": {
            "additionalProperties": {
                "properties": {
                    "additionalItems": {
                        "type": "boolean"
                    },
                    "default": {},
                    "description": {
                        "type": "string"
                    },
                    "enum": {
                        "type": "array"
                    },
                    "items": {
                        "properties": {
                            "enum": {
                                "type": "array"
                            },
                            "type": {
                                "enum": [
                                    "array",
                                    "boolean",
                                    "integer",
                                    "number",
                                    "object",
                                    "string",
                                    null
                                ],
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "maxItems": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maxLength": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maximum": {
                        "type": "number"
                    },
                    "minItems": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minLength": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minimum": {
                        "type": "number"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "operators": {
                        "items": {
                            "type": "string"
                        },
                        "type": "array"
                    },
                    "pattern": {
                        "format": "regex",
                        "type": "string"
                    },
                    "readonly": {
                        "type": "boolean"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "enum": [
                            "array",
                            "boolean",
                            "integer",
                            "number",
                            "object",
                            "string",
                            null
                        ],
                        "type": "string"
                    },
                    "uniqueItems": {
                        "default": false,
                        "type": "boolean"
                    }
                },
                "required": [
                    "title",
                    "type"
                ],
                "type": "object"
            },
            "type": "object"
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true
        }
    },
    "links": [
        {
            "href": "{first}",
            "rel": "first"
        },
        {
            "href": "{next}",
            "rel": "next"
        },
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "name": "objects",
    "properties": {
        "first": {
            "type": "string"
        },
        "next": {
            "type": "string"
        },
        "objects": {
            "items": {
                "additionalProperties": false,
                "name": "object",
                "properties": {
                    "created_at": {
                        "description": "Date and time of object creation",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "description": {
                        "type": "string"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "properties": {
                        "$ref": "#/definitions/property"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "schema": {
                        "readOnly": true,
                        "type": "string"
                    },
                    "self": {
                        "readOnly": true,
                        "type": "string"
                    },
                    "updated_at": {
                        "description": "Date and time of the last object modification",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "required": [
                    "name"
                ]
            },
            "type": "array"
        },
        "schema": {
            "type": "string"
        }
    }
}

GET

/v2/schemas/metadefs/property

Show metadata definition property schema

detail

Shows a JSON schema document that represents a metadata definition property entity.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "additionalProperties": false,
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
        }
    },
    "name": "property",
    "properties": {
        "additionalItems": {
            "type": "boolean"
        },
        "default": {},
        "description": {
            "type": "string"
        },
        "enum": {
            "type": "array"
        },
        "items": {
            "properties": {
                "enum": {
                    "type": "array"
                },
                "type": {
                    "enum": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "object",
                        "string",
                        null
                    ],
                    "type": "string"
                }
            },
            "type": "object"
        },
        "maxItems": {
            "$ref": "#/definitions/positiveInteger"
        },
        "maxLength": {
            "$ref": "#/definitions/positiveInteger"
        },
        "maximum": {
            "type": "number"
        },
        "minItems": {
            "$ref": "#/definitions/positiveIntegerDefault0"
        },
        "minLength": {
            "$ref": "#/definitions/positiveIntegerDefault0"
        },
        "minimum": {
            "type": "number"
        },
        "name": {
            "maxLength": 255,
            "type": "string"
        },
        "operators": {
            "items": {
                "type": "string"
            },
            "type": "array"
        },
        "pattern": {
            "format": "regex",
            "type": "string"
        },
        "readonly": {
            "type": "boolean"
        },
        "required": {
            "$ref": "#/definitions/stringArray"
        },
        "title": {
            "type": "string"
        },
        "type": {
            "enum": [
                "array",
                "boolean",
                "integer",
                "number",
                "object",
                "string",
                null
            ],
            "type": "string"
        },
        "uniqueItems": {
            "default": false,
            "type": "boolean"
        }
    },
    "required": [
        "type",
        "title",
        "name"
    ]
}

GET

/v2/schemas/metadefs/properties

Show metadata definition properties schema

detail

Shows a JSON schema document that represents a metadata definition properties entity.

A properties entity is a container for property entities.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200 Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "definitions": {
        "positiveInteger": {
            "minimum": 0,
            "type": "integer"
        },
        "positiveIntegerDefault0": {
            "allOf": [
                {
                    "$ref": "#/definitions/positiveInteger"
                },
                {
                    "default": 0
                }
            ]
        },
        "stringArray": {
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
        }
    },
    "links": [
        {
            "href": "{first}",
            "rel": "first"
        },
        {
            "href": "{next}",
            "rel": "next"
        },
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "name": "properties",
    "properties": {
        "first": {
            "type": "string"
        },
        "next": {
            "type": "string"
        },
        "properties": {
            "additionalProperties": {
                "additionalProperties": false,
                "name": "property",
                "properties": {
                    "additionalItems": {
                        "type": "boolean"
                    },
                    "default": {},
                    "description": {
                        "type": "string"
                    },
                    "enum": {
                        "type": "array"
                    },
                    "items": {
                        "properties": {
                            "enum": {
                                "type": "array"
                            },
                            "type": {
                                "enum": [
                                    "array",
                                    "boolean",
                                    "integer",
                                    "number",
                                    "object",
                                    "string",
                                    null
                                ],
                                "type": "string"
                            }
                        },
                        "type": "object"
                    },
                    "maxItems": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maxLength": {
                        "$ref": "#/definitions/positiveInteger"
                    },
                    "maximum": {
                        "type": "number"
                    },
                    "minItems": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minLength": {
                        "$ref": "#/definitions/positiveIntegerDefault0"
                    },
                    "minimum": {
                        "type": "number"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "operators": {
                        "items": {
                            "type": "string"
                        },
                        "type": "array"
                    },
                    "pattern": {
                        "format": "regex",
                        "type": "string"
                    },
                    "readonly": {
                        "type": "boolean"
                    },
                    "required": {
                        "$ref": "#/definitions/stringArray"
                    },
                    "title": {
                        "type": "string"
                    },
                    "type": {
                        "enum": [
                            "array",
                            "boolean",
                            "integer",
                            "number",
                            "object",
                            "string",
                            null
                        ],
                        "type": "string"
                    },
                    "uniqueItems": {
                        "default": false,
                        "type": "boolean"
                    }
                },
                "required": [
                    "type",
                    "title"
                ]
            },
            "type": "object"
        },
        "schema": {
            "type": "string"
        }
    }
}

GET

/v2/schemas/metadefs/tag

Show metadata definition tag schema

detail

Shows a JSON schema document that represents a metadata definition tag entity.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "additionalProperties": false,
    "name": "tag",
    "properties": {
        "created_at": {
            "description": "Date and time of tag creation",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        },
        "name": {
            "maxLength": 255,
            "type": "string"
        },
        "updated_at": {
            "description": "Date and time of the last tag modification",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "name"
    ]
}

GET

/v2/schemas/metadefs/tags

Show metadata definition tags schema

detail

Shows a JSON schema document that represents a metadata definition tags entity.

A tags entity is a container for tag entities.

The following schema document is an example. The authoritative response is the actual response to the API call.

Normal response codes: 200

Error response codes: 400, 401

Request

There are no request parameters. The call does not take a request body.

Response Example

{
    "links": [
        {
            "href": "{first}",
            "rel": "first"
        },
        {
            "href": "{next}",
            "rel": "next"
        },
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "name": "tags",
    "properties": {
        "first": {
            "type": "string"
        },
        "next": {
            "type": "string"
        },
        "schema": {
            "type": "string"
        },
        "tags": {
            "items": {
                "additionalProperties": false,
                "name": "tag",
                "properties": {
                    "created_at": {
                        "description": "Date and time of tag creation",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    },
                    "name": {
                        "maxLength": 255,
                        "type": "string"
                    },
                    "updated_at": {
                        "description": "Date and time of the last tag modification",
                        "format": "date-time",
                        "readOnly": true,
                        "type": "string"
                    }
                },
                "required": [
                    "name"
                ]
            },
            "type": "array"
        }
    }
}