OpenStack API Reference

https://docs.openstack.org/api-ref/
Admin
Provides a comprehensive index and documentation for the Application Programming Interfaces (APIs)...
Tokens:1,765,575
Snippets:10,495
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Migration Get Process Response Example

Source: https://docs.openstack.org/api-ref/shared-file-system

Example response body showing migration progress and task state.

```json
{
    "total_progress": 100,
    "task_state": "migration_driver_phase1_done"
}
```

--------------------------------

### Start Host Response Example

Source: https://docs.openstack.org/api-ref/compute/index.html

JSON response body returned when a host startup action is performed.

```json
{
    "host": "4b392b27930343bbaa27fd5d8328a564",
    "power_action": "startup"
}
```

--------------------------------

### List database instances response example

Source: https://docs.openstack.org/api-ref/database

Example JSON response body for the GET /v1.0/{project_id}/instances endpoint.

```json
{
    "instances": [
        {
            "datastore": {
                "type": "mysql",
                "version": "5.7"
            },
            "flavor": {
                "id": "6"
            },
            "id": "7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
            "ip": [
                "10.1.0.62",
                "172.24.5.114"
            ],
            "links": [
                {
                    "href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/instances/7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
                    "rel": "self"
                },
                {
                    "href": "https://127.0.0.1:8779/instances/7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
                    "rel": "bookmark"
                }
            ],
            "name": "test",
            "operating_status": "HEALTHY",
            "region": "RegionOne",
            "status": "ACTIVE",
            "volume": {
                "size": 1
            }
        }
    ]
}
```

--------------------------------

### GET /v2.1/ Response Example

Source: https://docs.openstack.org/api-ref/compute/index.html

Example JSON response for a GET request to the /v2.1/ endpoint on a current server.

```json
{
    "version": {
        "id": "v2.1",
        "links": [
            {
                "href": "http://openstack.example.com/v2.1/",
                "rel": "self"
            },
            {
                "href": "http://docs.openstack.org/",
                "rel": "describedby",
                "type": "text/html"
            }
        ],
        "media-types": [
            {
                "base": "application/json",
                "type": "application/vnd.openstack.compute+json;version=2.1"
            }
        ],
        "status": "CURRENT",
        "version": "2.104",
        "min_version": "2.1",
        "updated": "2013-07-23T11:33:21Z"
    }
}
```

--------------------------------

### Create Server with Scheduler Hints

Source: https://docs.openstack.org/api-ref/compute/index.html

Example of creating a server with basic metadata, personality files, and scheduler hints for host affinity.

```json
{
    "server" : {
        "accessIPv4": "1.2.3.4",
        "accessIPv6": "80fe::",
        "name" : "new-server-test",
        "imageRef" : "70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef" : "1",
        "availability_zone": "us-west",
        "OS-DCF:diskConfig": "AUTO",
        "metadata" : {
            "My Server Name" : "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6 b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ],
        "security_groups": [
            {
                "name": "default"
            }
        ],
        "user_data" : "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg=="
    },
    "OS-SCH-HNT:scheduler_hints": {
        "same_host": "48e6a9f6-30af-47e0-bc04-acaed113bb4e"
    }
}
```

--------------------------------

### Get Subscription Response Example

Source: https://docs.openstack.org/api-ref/message/index.html

This is an example of the response body when retrieving subscription details.

```json
{
  "age": 1632,
  "id": "576b54963990b48c644bb7e7",
  "subscriber": "http://10.229.49.117:5679",
  "source": "test",
  "ttl": 3600,
  "options": {
    "name": "test"
  }
}

```

--------------------------------

### Create User Example

Source: https://docs.openstack.org/api-ref/identity/v3/index.html

This example shows the JSON response when creating a user. It includes user details and links for further actions.

```json
{
    "links": {
        "next": null,
        "previous": null,
        "self": "http://example.com/identity/v3/users"
    },
    "users": [
        {
            "domain_id": "default",
            "enabled": true,
            "id": "2844b2a08be147a08ef58317d6471f1f",
            "links": {
                "self": "http://example.com/identity/v3/users/2844b2a08be147a08ef58317d6471f1f"
            },
            "name": "glance",
            "password_expires_at": null
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "4ab84ab39de54f4d96eaff8f2145a7cd",
            "links": {
                "self": "http://example.com/identity/v3/users/4ab84ab39de54f4d96eaff8f2145a7cd"
            },
            "name": "swiftusertest1",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "56696a9a04864d63877a3d06a6f0b24b",
            "links": {
                "self": "http://example.com/identity/v3/users/56696a9a04864d63877a3d06a6f0b24b"
            },
            "name": "swift",
            "password_expires_at": null
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "5acb638d15da44fc8de41b9a4bd41875",
            "links": {
                "self": "http://example.com/identity/v3/users/5acb638d15da44fc8de41b9a4bd41875"
            },
            "name": "alt_demo",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "7596e862b1af473c8ed6ae99d35b51e3",
            "links": {
                "self": "http://example.com/identity/v3/users/7596e862b1af473c8ed6ae99d35b51e3"
            },
            "name": "demo",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "802edb2141b44e77bbde241417450749",
            "links": {
                "self": "http://example.com/identity/v3/users/802edb2141b44e77bbde241417450749"
            },
            "name": "nova",
            "password_expires_at": null
        },
        {
            "domain_id": "592ab0800d3745baaf45c610fa41950a",
            "enabled": true,
            "id": "9aca3883784647fe9aff3a50d922489a",
            "links": {
                "self": "http://example.com/identity/v3/users/9aca3883784647fe9aff3a50d922489a"
            },
            "name": "swiftusertest4",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "a1251b011f9345e68c2458b841152034",
            "links": {
                "self": "http://example.com/identity/v3/users/a1251b011f9345e68c2458b841152034"
            },
            "name": "swiftusertest3",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "a43f46eb318041f6b712143862e3ad70",
            "links": {
                "self": "http://example.com/identity/v3/users/a43f46eb318041f6b712143862e3ad70"
            },
            "name": "neutron",
            "password_expires_at": null
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "b964a9e51c0046a4a84d3f83a135a97c",
            "links": {
                "self": "http://example.com/identity/v3/users/b964a9e51c0046a4a84d3f83a135a97c"
            },
            "name": "admin",
            "password_expires_at": null
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "dc87e591c0d247d5ac04e873bd8a1646",
            "links": {
                "self": "http://example.com/identity/v3/users/dc87e591c0d247d5ac04e873bd8a1646"
            },
            "name": "cinder",
            "password_expires_at": null
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "ed214dc1c2c6468b926c96eca6c8aee9",
            "links": {
                "self": "http://example.com/identity/v3/users/ed214dc1c2c6468b926c96eca6c8aee9"
            },
            "name": "glance-swift",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        },
        {
            "domain_id": "default",
            "enabled": true,
            "id": "f4f6587b058a4f46a00242549b430d37",
            "links": {
                "self": "http://example.com/identity/v3/users/f4f6587b058a4f46a00242549b430d37"
            },
            "name": "swiftusertest2",
            "password_expires_at": "2016-11-06T15:32:17.000000"
        }
    ]
}
```

--------------------------------

### Recordset GET Response Example

Source: https://docs.openstack.org/api-ref/dns/dns-api-v2-index.html

Example JSON response body returned when retrieving a recordset.

```json
{
    "description": "This is an example record set.",
    "links": {
        "self": "https://127.0.0.1:9001/v2/zones/2150b1bf-dee2-4221-9d85-11f7886fb15f/recordsets/f7b10e9b-0cae-4a91-b162-562bc6096648"
    },
    "updated_at": null,
    "records": [
        "10.1.0.2"
    ],
    "ttl": 3600,
    "id": "f7b10e9b-0cae-4a91-b162-562bc6096648",
    "name": "example.org.",
    "project_id": "4335d1f0-f793-11e2-b778-0800200c9a66",
    "zone_id": "2150b1bf-dee2-4221-9d85-11f7886fb15f",
    "zone_name": "example.com.",
    "created_at": "2014-10-24T19:59:44.000000",
    "version": 1,
    "type": "A",
    "status": "ACTIVE",
    "action": "NONE"
}
```

--------------------------------

### Create Deploy Template Response Example

Source: https://docs.openstack.org/api-ref/baremetal/?expanded=update-node-detail

Example response returned after successfully creating a deploy template, including resource metadata and links.

```json
{
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "links": [
    {
      "href": "http://10.60.253.180:6385/v1/deploy_templates/bbb45f41-d4bc-4307-8d1d-32f95ce1e920",
      "rel": "self"
    },
    {
      "href": "http://10.60.253.180:6385/deploy_templates/bbb45f41-d4bc-4307-8d1d-32f95ce1e920",
      "rel": "bookmark"
    }
  ],
  "name": "CUSTOM_HYPERTHREADING_ON",
  "steps": [
    {
      "args": {
        "settings": [
          {
            "name": "LogicalProc",
            "value": "Enabled"
          }
        ]
      },
      "interface": "bios",
      "priority": 150,
      "step": "apply_configuration"
    }
  ],
  "updated_at": null,
  "uuid": "bbb45f41-d4bc-4307-8d1d-32f95ce1e920"
}
```

--------------------------------

### List Loggable Resources Response Example

Source: https://docs.openstack.org/api-ref/network/v2

Example JSON response body for the GET /v2.0/log/loggable-resources request.

```json
{
    "loggable_resources": [
        {
            "type": "security_group"
        }
    ]
}
```

--------------------------------

### List User Projects Example

Source: https://docs.openstack.org/api-ref/identity/v3/index.html

This example demonstrates the JSON response for listing projects a user has access to. It details project attributes such as description, domain ID, enabled status, ID, links, name, and parent ID.

```json
{
    "projects": [
        {
            "description": "description of this project",
            "domain_id": "161718",
            "enabled": true,
            "id": "456788",
            "links": {
                "self": "http://example.com/identity/v3/projects/456788"
            },
            "name": "a project name",
            "parent_id": "212223"
        },
        {
            "description": "description of this project",
            "domain_id": "161718",
            "enabled": true,
            "id": "456789",
            "links": {
                "self": "http://example.com/identity/v3/projects/456789"
            },
            "name": "another domain",
            "parent_id": "212223"
        }
    ],
    "links": {
        "self": "http://example.com/identity/v3/users/313233/projects",
        "previous": null,
        "next": null
    }
}


```

--------------------------------

### Sign Up Request

Source: https://docs.openstack.org/api-ref/admin-logic/v1-api-reference.html

Registers a new user and project with optional network and region configuration.

```bash
curl -H 'X-Auth-Token: $OS_TOKEN' -H 'Content-Type: application/json' -d '{
    "email": "example@example.com", "project_name": "example_project"}'
    -X POST  http://0.0.0.0:5050/v1/openstack/sign-up
```

--------------------------------

### Get Stack Files Response Example

Source: https://docs.openstack.org/api-ref/orchestration/v1/?expanded=update-stack-patch-detail

Example JSON response containing a map of file names and their contents.

```json
{
    "file:///home/username/hello.sh": "#!/bin/sh\necho hello\n"
}
```

--------------------------------

### Get Archive Response Example

Source: https://docs.openstack.org/api-ref/application-container/index.html

Example of a successful response when retrieving archive data and stat information from a container.

```json
{
    "stat": {
        "linkTarget": "",
        "size": 129,
        "mode": 493,
        "name": "ip.sh",
        "mtime": "2017-07-25T18:54:50-07:00"
    },
    "data": "ARCHIVE FILE DATA"
}


```

--------------------------------

### Software Deployment Response Example

Source: https://docs.openstack.org/api-ref/orchestration/v1/?expanded=update-stack-patch-detail

Example JSON response containing a list of software deployments.

```json
{
    "software_deployments": [
        {
            "status": "COMPLETE",
            "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
            "config_id": "8da95794-2ad9-4979-8ae5-739ce314c5cd",
            "output_values": {
                "deploy_stdout": "Writing to /tmp/barmy\nWritten to /tmp/barmy\n",
                "deploy_stderr": "+ echo Writing to /tmp/barmy\n+ echo fu\n+ cat /tmp/barmy\n+ echo -n The file /tmp/barmy contains fu for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/barmy\n+ echo Output to stderr\nOutput to stderr\n",
                "deploy_status_code": 0,
                "result": "The file /tmp/barmy contains fu for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
            },
            "input_values": null,
            "action": "CREATE",
            "status_reason": "Outputs received",
            "id": "ef422fa5-719a-419e-a10c-72e3a367b0b8",
            "creation_time": "2015-01-31T15:12:36Z",
            "updated_time": "2015-01-31T15:18:21Z"
        }
    ]
}
```

--------------------------------

### List Supported Boot Devices JSON Response

Source: https://docs.openstack.org/api-ref/baremetal/?expanded=update-node-detail

Example response body listing the boot devices supported by the node's driver.

```json
{
  "supported_boot_devices": [
    "pxe"
  ]
}
```

--------------------------------

### Get Action Details Response Example

Source: https://docs.openstack.org/api-ref/backup/v2

Example JSON response containing the full details of a specific action.

```json
{
        "freezer_action":
        {
            "backup_name": "production_backup",
            "container": "prod_container",
            "no_incremental": true,
            "path_to_backup": "/etc/",
            "snapshot": true,
            "action": "backup",
            "remove_older_than": 365,
            "log_file": "/var/log/freezer/job0001.log"
        },
        "max_retries_interval": 6,
        "_version": 1,
        "max_retries": 5,
        "user_id": "0cd44caf6db5486b94a04b33256a5ff4",
        "project_id": "752d8bd43d654e7a840bbfda77ce41af",
        "action_id": "1fc414f091b84263b45d7e1f1f85e5bf"
}
```

--------------------------------

### Retrieve Default Configuration Parameters

Source: https://docs.openstack.org/api-ref/database

Example JSON response showing the default configuration settings for a database instance.

```json
{
    "instance": {
        "configuration": {
            "basedir": "/usr",
            "connect_timeout": 15,
            "datadir": "/var/lib/mysql/data",
            "default_storage_engine": "innodb",
            "innodb_buffer_pool_size": "2401M",
            "innodb_data_file_path": "ibdata1:10M:autoextend",
            "innodb_file_per_table": 1,
            "innodb_log_buffer_size": "25M",
            "innodb_log_file_size": "50M",
            "innodb_log_files_in_group": 2,
            "join_buffer_size": "1M",
            "key_buffer_size": "800M",
            "local-infile": 0,
            "max_allowed_packet": "16392K",
            "max_connections": 1600,
            "max_heap_table_size": "256M",
            "max_user_connections": 1600,
            "myisam-recover-options": "BACKUP,FORCE",
            "open_files_limit": 8196,
            "performance_schema": "ON",
            "pid-file": "/var/run/mysqld/mysqld.pid",
            "port": 3306,
            "query_cache_limit": "1M",
            "query_cache_size": "128M",
            "query_cache_type": 1,
            "read_buffer_size": "512K",
            "read_rnd_buffer_size": "512K",
            "server_id": 1468542390,
            "skip-external-locking": 1,
            "socket": "/var/run/mysqld/mysqld.sock",
            "sort_buffer_size": "1M",
            "table_definition_cache": 4098,
            "table_open_cache": 4098,
            "thread_cache_size": 64,
            "thread_stack": "192K",
            "tmp_table_size": "256M",
            "tmpdir": "/var/tmp",
            "user": "mysql",
            "wait_timeout": 120
        }
    }
}
```

--------------------------------

### Get Container Stats Request

Source: https://docs.openstack.org/api-ref/application-container/index.html

This is an example of a GET request to retrieve statistics for a specific container. It shows the endpoint for the request.

```http
GET
/v1/containers/{container_ident}/stats

```

--------------------------------

### Example LDAP Configuration

Source: https://docs.openstack.org/api-ref/identity/v3/index.html

Illustrates a sample configuration structure for LDAP settings.

```json
{
    "ldap": {
        "url": "ldap://localhost",
        "user": "",
        "suffix": "cn=example,cn=com".
        ....
    }
}

```

--------------------------------

### StartInstances

Source: https://docs.openstack.org/api-ref/ec2-api

Starts one or more instances. This operation is supported for instances.

```APIDOC
## StartInstances

### Description
Starts one or more instances.

### Method
POST (Assumed based on operation name)

### Endpoint
/instances/start (Assumed path structure)

### Parameters
#### Request Body
- **InstanceIds** (array of strings) - Required - A list of instance IDs to start.
```

--------------------------------

### List BGP Peers Response Example

Source: https://docs.openstack.org/api-ref/network/v2

Example JSON response body for a successful GET request to list all BGP peers.

```json
{
   "bgp_peers":[
      {
         "auth_type":"none",
         "remote_as":1001,
         "name":"bgp-peer",
         "tenant_id":"34a6e17a48cf414ebc890367bf42266b",
         "peer_ip":"10.0.0.3",
         "id":"a7193581-a31c-4ea5-8218-b3052758461f"
      }
   ]
}
```

--------------------------------

### Show API v2 details response example

Source: https://docs.openstack.org/api-ref/network/v2

Example JSON response for the GET /v2.0/ request, listing available resources.

```json
{
    "resources": [
        {
            "links": [
                {
                    "href": "http://23.253.228.211:9696/v2.0/subnets",
                    "rel": "self"
                }
            ],
            "name": "subnet",
            "collection": "subnets"
        },
        {
            "links": [
                {
                    "href": "http://23.253.228.211:9696/v2.0/networks",
                    "rel": "self"
                }
            ],
            "name": "network",
            "collection": "networks"
        },
        {
            "links": [
                {
                    "href": "http://23.253.228.211:9696/v2.0/ports",
                    "rel": "self"
                }
            ],
            "name": "port",
            "collection": "ports"
        }
    ]
}
```

--------------------------------

### Create Server with Host and Hypervisor Hostname

Source: https://docs.openstack.org/api-ref/compute/index.html

Example of creating a server specifying the target host and hypervisor hostname (v2.74).

```json
{
    "server" : {
        "adminPass": "MySecretPass",
        "accessIPv4": "1.2.3.4",
        "accessIPv6": "80fe::",
        "name" : "new-server-test",
        "imageRef" : "70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef" : "6",
        "OS-DCF:diskConfig": "AUTO",
        "metadata" : {
            "My Server Name" : "Apache1"
        },
        "security_groups": [
            {
                "name": "default"
            }
        ],
        "user_data" : "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg==",
        "networks": "auto",
        "host": "openstack-node-01",
        "hypervisor_hostname": "openstack-node-01"
    }
}
```

--------------------------------

### GET /resource_providers/{uuid}/traits Response Example

Source: https://docs.openstack.org/api-ref/placement/index.html?expanded=delete-resource-provider-inventories-detail

Example of a successful response when listing traits for a resource provider.

```json
{
    "resource_provider_generation": 1,
    "traits": [
        "CUSTOM_HW_FPGA_CLASS1",
        "CUSTOM_HW_FPGA_CLASS3"
    ]
}

```

--------------------------------

### Create Deploy Template Request Example

Source: https://docs.openstack.org/api-ref/baremetal/?expanded=update-node-detail

JSON payload for creating a new deploy template with specific BIOS configuration steps.

```json
{
    "extra": {},
    "name": "CUSTOM_HYPERTHREADING_ON",
    "steps": [
        {
            "interface": "bios",
            "step": "apply_configuration",
            "args": {
                "settings": [
                    {
                        "name": "LogicalProc",
                        "value": "Enabled"
                    }
                ]
            },
            "priority": 150
        }
    ]
}
```

--------------------------------

### Response Example for GET /resource_providers/{uuid}/traits

Source: https://docs.openstack.org/api-ref/placement/index.html

Example of a successful response when listing traits for a resource provider.

```json
{
    "resource_provider_generation": 1,
    "traits": [
        "CUSTOM_HW_FPGA_CLASS1",
        "CUSTOM_HW_FPGA_CLASS3"
    ]

}
```

--------------------------------

### List Attachments Detail Response Example

Source: https://docs.openstack.org/api-ref/block-storage/v3

Example JSON response body returned by the GET /v3/{project_id}/attachments/detail endpoint.

```json
{
    "attachments": [
        {
            "status": "attaching",
            "detached_at": "2015-09-16T09:28:52.000000",
            "connection_info": {},
            "attached_at": "2015-09-16T09:28:52.000000",
            "attach_mode": "ro",
            "instance": "31c79baf-b59e-469c-979f-1df4ecb6eea7",
            "volume_id": "462dcc2d-130d-4654-8db1-da0df2da6a0d",
            "id": "3b8b6631-1cf7-4fd7-9afb-c01e541a073c"
        }
    ]
}
```

--------------------------------

### Create Runbook Request Example

Source: https://docs.openstack.org/api-ref/baremetal/?expanded=update-node-detail

Example JSON payload for creating a new runbook with a custom name and bios configuration step.

```json
{
    "extra": {},
    "name": "CUSTOM_AWESOME",
    "steps": [
        {
            "interface": "bios",
            "step": "apply_configuration",
            "args": {
                "settings": [
                    {
                        "name": "LogicalProc",
                        "value": "Enabled"
                    }
                ]
            },
            "order": 1
        }
    ]
}
```

--------------------------------

### List All Deployables Response

Source: https://docs.openstack.org/api-ref/accelerator/index.html

Example JSON response body returned when listing all available deployables.

```json
{
   "deployables":
   [
      {
         "uuid": "29e23349-12ee-4978-963c-11484a4ae601",
         "parent_id": null,
         "root_id": null,
         "name": "computenode_FakeDevice",
         "num_accelerators": 16,
         "device_id": 1,
         "attributes_list": "[{'traits1': 'CUSTOM_FAKE_DEVICE'}, {'rc': 'FPGA'}]",
         "rp_uuid": "853f07a6-19de-3dd6-b9f6-6c782daa3f7b",
         "driver_name": "fake",
         "bitstream_id": null,
         "created_at": "2020-03-13T02:27:35+00:00",
         "updated_at": "2020-03-13T02:27:36+00:00",
         "links":
         [
            {
               "href": "http://localhost/accelerator/v2/deployables/29e23349-12ee-4978-963c-11484a4ae601",
               "rel": "self"
            },
            {
               "href": "http://localhost/accelerator/deployables/29e23349-12ee-4978-963c-11484a4ae601",
               "rel": "bookmark"
            }
         ]
      }
   ]
}
```

--------------------------------

### List Domains Response Example

Source: https://docs.openstack.org/api-ref/identity/v3/index.html

Example JSON response for the GET /v3/auth/domains endpoint. It shows the structure of available domain scopes for authentication.

```json
{
    "domains": [
        {
            "description": "my domain description",
            "enabled": true,
            "id": "1789d1",
            "links": {
                "self": "https://example.com/identity/v3/domains/1789d1"
            },
            "name": "my domain"
        },
        {
            "description": "description of my other domain",
            "enabled": true,
            "id": "43e8da",
            "links": {
                "self": "https://example.com/identity/v3/domains/43e8da"
            },
            "name": "another domain"
        }
    ],
    "links": {
        "self": "https://example.com/identity/v3/auth/domains",
        "previous": null,
        "next": null
    }
}

```

--------------------------------

### Create Software Configuration Response Example

Source: https://docs.openstack.org/api-ref/orchestration/v1/?expanded=update-stack-patch-detail

JSON response body returned after successfully creating a software configuration, including the generated UUID.

```json
{
    "software_config": {
        "creation_time": "2015-01-31T15:12:36Z",
        "inputs": [
            {
                "default": null,
                "type": "String",
                "name": "foo",
                "description": null
            },
            {
                "default": null,
                "type": "String",
                "name": "bar",
                "description": null
            }
        ],
        "group": "script",
        "name": "a-config-we5zpvyu7b5o",
        "outputs": [
            {
                "type": "String",
                "name": "result",
                "error_output": false,
                "description": null
            }
        ],
        "options": null,
        "config": "#!/bin/sh -x\necho \"Writing to /tmp/$bar\"\necho $foo > /tmp/$bar\necho -n \"The file /tmp/$bar contains `cat /tmp/$bar` for server $deploy_server_id during $deploy_action\" > $heat_outputs_path.result\necho \"Written to /tmp/$bar\"\necho \"Output to stderr\" 1>&2",
        "id": "ddee7aca-aa32-4335-8265-d436b20db4f1"
    }
}
```

--------------------------------

### Example Response for GET /resource_providers/{uuid}/inventories/{resource_class}

Source: https://docs.openstack.org/api-ref/placement/index.html

This is an example of the JSON response when retrieving resource provider inventory details.

```json
{
    "allocation_ratio": 16.0,
    "max_unit": 4,
    "min_unit": 1,
    "reserved": 0,
    "resource_provider_generation": 9,
    "step_size": 1,
    "total": 4
}
```

--------------------------------

### GET /v2/pools

Source: https://docs.openstack.org/api-ref/dns/dns-api-v2-index.html

Retrieves a list of all pools available in the Designate installation.

```APIDOC
## GET /v2/pools

### Description
Get the list of Pools.

### Method
GET

### Endpoint
/v2/pools

### Parameters
#### Request Headers
- **x-auth-token** (string) - Optional - Token used to identify the user from keystone
- **x-auth-all-projects** (bool) - Optional - If enabled this will show results from all projects in Designate
- **x-auth-sudo-project-id** (string) - Optional - This allows a user to impersonate another project

### Response
#### Success Response (200)
- **x-openstack-request-id** (header, string) - ID of the request
- **description** (body, string) - Description for the resource
- **id** (body, uuid) - ID for this pool
- **attributes** (body, object) - Key:Value pairs of information about this pool
- **project_id** (body, uuid) - ID for the project that owns the resource
- **ns_records** (body, string) - Name Servers for this pool
- **name** (body, string) - Name for this pool
- **created_at** (body, datestamp) - Date / Time when resource was created
- **updated_at** (body, datestamp) - Date / Time when resource last updated
- **links** (body, object) - Links to the resource
- **metadata** (body, object) - Returns the total_count of resources matching this filter
```

--------------------------------

### Create Subscription Response Example

Source: https://docs.openstack.org/api-ref/message/index.html

Example response body after successfully creating a subscription.

```json
{
  "subscription_id": "57692ab13990b48c644bb7e6"
}

```

--------------------------------

### Response Example for Software Deployment

Source: https://docs.openstack.org/api-ref/orchestration/v1/?expanded=update-stack-patch-detail

JSON response containing the updated software deployment details.

```json
{
    "software_deployment": {
        "status": "COMPLETE",
        "server_id": "ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5",
        "config_id": "3d5ec2a8-7004-43b6-a7f6-542bdbe9d434",
        "output_values": {
            "deploy_stdout": "Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n",
            "deploy_stderr": "+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n",
            "deploy_status_code": 0,
            "result": "The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"
        },
        "input_values": null,
        "action": "CREATE",
        "status_reason": "Outputs received",
        "id": "06e87bcc-33a2-4bce-aebd-533e698282d3",
        "creation_time": "2015-01-31T15:12:36Z",
        "updated_time": "2015-01-31T15:18:21Z"
    }
}
```

--------------------------------

### Show BGP Peer Details Response Example

Source: https://docs.openstack.org/api-ref/network/v2

Example JSON response body for a successful GET request to retrieve details of a specific BGP peer.

```json
{
   "bgp_peer":{
      "auth_type":"none",
      "remote_as":1001,
      "name":"bgp-peer",
      "tenant_id":"34a6e17a48cf414ebc890367bf42266b",
      "peer_ip":"10.0.0.3",
      "id":"a7193581-a31c-4ea5-8218-b3052758461f"
   }
}
```

--------------------------------

### Create Client Response Example

Source: https://docs.openstack.org/api-ref/backup/v2

JSON response returned after successfully creating a client.

```json
{"client_id": "752d8cd43d654e7a840bbfd277ce41af_szaher01"}
```

--------------------------------

### Get Enforcement Model Example

Source: https://docs.openstack.org/api-ref/identity/v3/index.html

Retrieves the configured limit enforcement model for the deployment. This example shows the expected JSON response for a 'flat' enforcement model.

```json
{
    "model": {
        "description": "Limit enforcement and validation does not take project hierarchy into consideration.",
        "name": "flat"
    }
}

```

--------------------------------

### Create Pool Request Example (Flavor)

Source: https://docs.openstack.org/api-ref/message/index.html

Example of a request body to create a pool using the 'flavor' attribute. This is the recommended approach starting from the Queens release.

```json
{
    "weight": 60,
    "uri": "mongodb://127.0.0.1:27017",
    "options":{
        "max_retry_sleep": 1
    },
    "flavor": "newpoolflavor"
}
```

--------------------------------

### Response Example for Listing Applications

Source: https://docs.openstack.org/api-ref/application-catalog/v1

Example JSON response when listing applications for an environment template. It includes details about instances and application configurations.

```json
[
  {
    "instance":
    {
      "assignFloatingIp": "true",
      "keyname": "mykeyname",
      "image": "cloud-fedora-v3",
      "flavor": "m1.medium",
      "?":
      {
        "type": "io.murano.resources.LinuxMuranoInstance",
        "id": "ef984a74-29a4-45c0-b1dc-2ab9f075732e"
      }
    },
    "name": "tomcat",
    "?":
    {
      "type": "io.murano.apps.apache.Tomcat",
      "id": "54cea43d-5970-4c73-b9ac-fea656f3c722"
    },
    "port": "8080"
  },
  {
    "instance": "ef984a74-29a4-45c0-b1dc-2ab9f075732e",
    "password": "XXX",
    "name": "mysql",
    "?":
    {
      "type": "io.murano.apps.database.MySQL",
      "id": "54cea43d-5970-4c73-b9ac-fea656f3c722"
    }
  }
]
```

--------------------------------

### POST /v1.0/{project_id}/instances

Source: https://docs.openstack.org/api-ref/database

Creates a new database instance. Requires specifying flavor ID, volume size, and network, unless creating a replica.

```APIDOC
## POST /v1.0/{project_id}/instances

### Description
Creates a database instance. Normally, you must specify a flavor ID, a volume size and the network the instance is attached to. The service provisions the instance with a volume of the requested size, which serves as storage for the database instance. If creating replica (a secondary instance of the replication cluster), flavor and volume size are not needed.

### Method
POST

### Endpoint
/v1.0/{project_id}/instances

### Parameters
#### Path Parameters
- **project_id** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **instances** (array) - A list of database instances.

#### Response Example
{
    "instances": [
        {
            "addresses": [
                {
                    "address": "10.1.0.62",
                    "type": "private",
                    "network": "3dc8f3c2-f335-11eb-878c-00224d6b7bc1"
                },
                {
                    "address": "172.24.5.114",
                    "type": "public"
                }
            ],
            "created": "2019-12-23T20:58:35",
            "datastore": {
                "type": "mysql",
                "version": "5.7"
            },
            "flavor": {
                "id": "6"
            },
            "id": "7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
            "ip": [
                "10.1.0.62",
                "172.24.5.114"
            ],
            "links": [
                {
                    "href": "https://127.0.0.1:8779/v1.0/9f8dd5eacb074c9f87d2d822c9092aa5/instances/7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
                    "rel": "self"
                },
                {
                    "href": "https://127.0.0.1:8779/instances/7de1bed8-6983-4d46-9a52-0abfbb0d27a2",
                    "rel": "bookmark"
                }
            ],
            "name": "test",
            "operating_status": "HEALTHY",
            "region": "RegionOne",
            "service_status_updated": "2019-12-23T21:01:11",
            "status": "ACTIVE",
            "updated": "2019-12-23T20:58:45",
            "volume": {
                "size": 1
            }
        }
    ]
}
```

--------------------------------

### Get Federation Mapping Example

Source: https://docs.openstack.org/api-ref/identity/v3-ext

Example JSON payload for retrieving a specific federated mapping. This shows the structure of a mapping including its ID, links, and rules.

```json
{
    "mapping": {
        "id": "ACME",
        "links": {
            "self": "http://example.com/identity/v3/OS-FEDERATION/mappings/ACME"
        },
        "rules": [
            {
                "local": [
                    {
                        "user": {
                            "name": "{0}"
                        }
                    },
                    {
                        "group": {
                            "id": "0cd5e9"
                        }
                    }
                ],
                "remote": [
                    {
                        "type": "UserName"
                    },
                    {
                        "type": "orgPersonType",
                        "not_any_of": [
                            "Contractor",
                            "Guest"
                        ]
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### Show Datastore Version Configuration Parameter

Source: https://docs.openstack.org/api-ref/database

Example response for a specific configuration parameter definition.

```json
{
    "datastore_version_id": "b3d5c099-dbd5-4518-baa3-7c7c195671bf",
    "max": 31536000,
    "min": 1,
    "name": "wait_timeout",
    "restart_required": false,
    "type": "integer"
}
```
Tokens:
Raw