API Examples

This document provides curl examples for interacting with the OpenStack Emulator APIs.

Authentication

Get a Token

TOKEN=$(curl -s -X POST http://localhost:5000/v3/auth/tokens \
  -H "Content-Type: application/json" \
  -d '{
    "auth": {
      "identity": {
        "methods": ["password"],
        "password": {
          "user": {
            "name": "admin",
            "domain": {"name": "Default"},
            "password": "s4l4dus"
          }
        }
      },
      "scope": {
        "project": {
          "name": "admin",
          "domain": {"name": "Default"}
        }
      }
    }
  }' -i | grep X-Subject-Token | cut -d' ' -f2 | tr -d '\r')

echo $TOKEN

Get Project ID

PROJECT_ID=$(curl -s http://localhost:5000/v3/auth/tokens \
  -H "X-Auth-Token: $TOKEN" \
  -H "X-Subject-Token: $TOKEN" | jq -r '.token.project.id')

echo $PROJECT_ID

Keystone (Identity)

Domains

# List domains
curl -s http://localhost:5000/v3/domains \
  -H "X-Auth-Token: $TOKEN" | jq

# Create domain
curl -s -X POST http://localhost:5000/v3/domains \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": {"name": "my-domain", "description": "My Domain"}}' | jq

# Get domain
curl -s http://localhost:5000/v3/domains/{domain_id} \
  -H "X-Auth-Token: $TOKEN" | jq

# Delete domain
curl -s -X DELETE http://localhost:5000/v3/domains/{domain_id} \
  -H "X-Auth-Token: $TOKEN"

Projects

# List projects
curl -s http://localhost:5000/v3/projects \
  -H "X-Auth-Token: $TOKEN" | jq

# Create project
curl -s -X POST http://localhost:5000/v3/projects \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project": {"name": "my-project", "description": "My Project"}}' | jq

# Update project
curl -s -X PATCH http://localhost:5000/v3/projects/{project_id} \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project": {"description": "Updated description"}}' | jq

# Delete project
curl -s -X DELETE http://localhost:5000/v3/projects/{project_id} \
  -H "X-Auth-Token: $TOKEN"

Users

# List users
curl -s http://localhost:5000/v3/users \
  -H "X-Auth-Token: $TOKEN" | jq

# Create user
curl -s -X POST http://localhost:5000/v3/users \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user": {"name": "newuser", "password": "secret123", "email": "user@example.com"}}' | jq

# Update user password
curl -s -X POST http://localhost:5000/v3/users/{user_id}/password \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"user": {"password": "newpassword", "original_password": "oldpassword"}}'

# Delete user
curl -s -X DELETE http://localhost:5000/v3/users/{user_id} \
  -H "X-Auth-Token: $TOKEN"

Roles

# List roles
curl -s http://localhost:5000/v3/roles \
  -H "X-Auth-Token: $TOKEN" | jq

# Assign role to user on project
curl -s -X PUT "http://localhost:5000/v3/projects/{project_id}/users/{user_id}/roles/{role_id}" \
  -H "X-Auth-Token: $TOKEN"

# Check role assignment
curl -s -X HEAD "http://localhost:5000/v3/projects/{project_id}/users/{user_id}/roles/{role_id}" \
  -H "X-Auth-Token: $TOKEN"

# Revoke role
curl -s -X DELETE "http://localhost:5000/v3/projects/{project_id}/users/{user_id}/roles/{role_id}" \
  -H "X-Auth-Token: $TOKEN"

# List role assignments
curl -s "http://localhost:5000/v3/role_assignments" \
  -H "X-Auth-Token: $TOKEN" | jq

Groups

# Create group
curl -s -X POST http://localhost:5000/v3/groups \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"group": {"name": "developers", "description": "Developer group"}}' | jq

# Add user to group
curl -s -X PUT "http://localhost:5000/v3/groups/{group_id}/users/{user_id}" \
  -H "X-Auth-Token: $TOKEN"

# List group users
curl -s "http://localhost:5000/v3/groups/{group_id}/users" \
  -H "X-Auth-Token: $TOKEN" | jq

Nova (Compute)

Servers

# List servers
curl -s http://localhost:8774/v2.1/servers \
  -H "X-Auth-Token: $TOKEN" | jq

# List servers (detailed)
curl -s http://localhost:8774/v2.1/servers/detail \
  -H "X-Auth-Token: $TOKEN" | jq

# Create server
curl -s -X POST http://localhost:8774/v2.1/servers \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server": {
      "name": "test-server",
      "flavorRef": "1",
      "imageRef": "{image_id}"
    }
  }' | jq

# Get server
curl -s http://localhost:8774/v2.1/servers/{server_id} \
  -H "X-Auth-Token: $TOKEN" | jq

# Server actions
curl -s -X POST http://localhost:8774/v2.1/servers/{server_id}/action \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"os-stop": null}'

curl -s -X POST http://localhost:8774/v2.1/servers/{server_id}/action \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"os-start": null}'

curl -s -X POST http://localhost:8774/v2.1/servers/{server_id}/action \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reboot": {"type": "SOFT"}}'

# Delete server
curl -s -X DELETE http://localhost:8774/v2.1/servers/{server_id} \
  -H "X-Auth-Token: $TOKEN"

Flavors

# List flavors
curl -s http://localhost:8774/v2.1/flavors \
  -H "X-Auth-Token: $TOKEN" | jq

# List flavors (detailed)
curl -s http://localhost:8774/v2.1/flavors/detail \
  -H "X-Auth-Token: $TOKEN" | jq

# Get flavor
curl -s http://localhost:8774/v2.1/flavors/{flavor_id} \
  -H "X-Auth-Token: $TOKEN" | jq

Keypairs

# List keypairs
curl -s http://localhost:8774/v2.1/os-keypairs \
  -H "X-Auth-Token: $TOKEN" | jq

# Create keypair
curl -s -X POST http://localhost:8774/v2.1/os-keypairs \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"keypair": {"name": "my-key"}}' | jq

# Import keypair
curl -s -X POST http://localhost:8774/v2.1/os-keypairs \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"keypair": {"name": "my-key", "public_key": "ssh-rsa AAAA..."}}' | jq

# Delete keypair
curl -s -X DELETE http://localhost:8774/v2.1/os-keypairs/my-key \
  -H "X-Auth-Token: $TOKEN"

Cinder (Block Storage)

Volumes

# List volumes
curl -s "http://localhost:8776/v3/$PROJECT_ID/volumes/detail" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create volume
curl -s -X POST "http://localhost:8776/v3/$PROJECT_ID/volumes" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"volume": {"name": "my-volume", "size": 10}}' | jq

# Get volume
curl -s "http://localhost:8776/v3/$PROJECT_ID/volumes/{volume_id}" \
  -H "X-Auth-Token: $TOKEN" | jq

# Update volume
curl -s -X PUT "http://localhost:8776/v3/$PROJECT_ID/volumes/{volume_id}" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"volume": {"name": "renamed-volume"}}' | jq

# Extend volume
curl -s -X POST "http://localhost:8776/v3/$PROJECT_ID/volumes/{volume_id}/action" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"os-extend": {"new_size": 20}}'

# Delete volume
curl -s -X DELETE "http://localhost:8776/v3/$PROJECT_ID/volumes/{volume_id}" \
  -H "X-Auth-Token: $TOKEN"

Snapshots

# List snapshots
curl -s "http://localhost:8776/v3/$PROJECT_ID/snapshots/detail" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create snapshot
curl -s -X POST "http://localhost:8776/v3/$PROJECT_ID/snapshots" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"snapshot": {"name": "my-snapshot", "volume_id": "{volume_id}"}}' | jq

# Delete snapshot
curl -s -X DELETE "http://localhost:8776/v3/$PROJECT_ID/snapshots/{snapshot_id}" \
  -H "X-Auth-Token: $TOKEN"

Volume Types

# List volume types
curl -s "http://localhost:8776/v3/$PROJECT_ID/types" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create volume type
curl -s -X POST "http://localhost:8776/v3/$PROJECT_ID/types" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"volume_type": {"name": "ssd", "description": "SSD storage"}}' | jq

Glance (Image)

Images

# List images
curl -s "http://localhost:9292/v2/images" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create image
curl -s -X POST "http://localhost:9292/v2/images" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-image", "container_format": "bare", "disk_format": "qcow2"}' | jq

# Get image
curl -s "http://localhost:9292/v2/images/{image_id}" \
  -H "X-Auth-Token: $TOKEN" | jq

# Update image (JSON Patch)
curl -s -X PATCH "http://localhost:9292/v2/images/{image_id}" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/openstack-images-v2.1-json-patch" \
  -d '[{"op": "replace", "path": "/name", "value": "new-name"}]' | jq

# Upload image data
curl -s -X PUT "http://localhost:9292/v2/images/{image_id}/file" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @/path/to/image.qcow2

# Add tag
curl -s -X PUT "http://localhost:9292/v2/images/{image_id}/tags/my-tag" \
  -H "X-Auth-Token: $TOKEN"

# Deactivate image
curl -s -X POST "http://localhost:9292/v2/images/{image_id}/actions/deactivate" \
  -H "X-Auth-Token: $TOKEN"

# Delete image
curl -s -X DELETE "http://localhost:9292/v2/images/{image_id}" \
  -H "X-Auth-Token: $TOKEN"

Image Sharing

# Set visibility to shared
curl -s -X PATCH "http://localhost:9292/v2/images/{image_id}" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/openstack-images-v2.1-json-patch" \
  -d '[{"op": "replace", "path": "/visibility", "value": "shared"}]'

# Add member (share with project)
curl -s -X POST "http://localhost:9292/v2/images/{image_id}/members" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"member": "{project_id}"}' | jq

# List members
curl -s "http://localhost:9292/v2/images/{image_id}/members" \
  -H "X-Auth-Token: $TOKEN" | jq

Neutron (Networking)

Networks

# List networks
curl -s "http://localhost:9696/v2.0/networks" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create network
curl -s -X POST "http://localhost:9696/v2.0/networks" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"network": {"name": "my-network", "admin_state_up": true}}' | jq

# Get network
curl -s "http://localhost:9696/v2.0/networks/{network_id}" \
  -H "X-Auth-Token: $TOKEN" | jq

# Delete network
curl -s -X DELETE "http://localhost:9696/v2.0/networks/{network_id}" \
  -H "X-Auth-Token: $TOKEN"

Subnets

# List subnets
curl -s "http://localhost:9696/v2.0/subnets" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create subnet
curl -s -X POST "http://localhost:9696/v2.0/subnets" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subnet": {
      "name": "my-subnet",
      "network_id": "{network_id}",
      "ip_version": 4,
      "cidr": "10.0.0.0/24"
    }
  }' | jq

# Delete subnet
curl -s -X DELETE "http://localhost:9696/v2.0/subnets/{subnet_id}" \
  -H "X-Auth-Token: $TOKEN"

Ports

# List ports
curl -s "http://localhost:9696/v2.0/ports" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create port
curl -s -X POST "http://localhost:9696/v2.0/ports" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"port": {"name": "my-port", "network_id": "{network_id}"}}' | jq

# Delete port
curl -s -X DELETE "http://localhost:9696/v2.0/ports/{port_id}" \
  -H "X-Auth-Token: $TOKEN"

Routers

# List routers
curl -s "http://localhost:9696/v2.0/routers" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create router
curl -s -X POST "http://localhost:9696/v2.0/routers" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"router": {"name": "my-router", "admin_state_up": true}}' | jq

# Set external gateway
curl -s -X PUT "http://localhost:9696/v2.0/routers/{router_id}" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"router": {"external_gateway_info": {"network_id": "{external_network_id}"}}}' | jq

# Add router interface
curl -s -X PUT "http://localhost:9696/v2.0/routers/{router_id}/add_router_interface" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subnet_id": "{subnet_id}"}' | jq

# Remove router interface
curl -s -X PUT "http://localhost:9696/v2.0/routers/{router_id}/remove_router_interface" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subnet_id": "{subnet_id}"}' | jq

# Delete router
curl -s -X DELETE "http://localhost:9696/v2.0/routers/{router_id}" \
  -H "X-Auth-Token: $TOKEN"

Floating IPs

# List floating IPs
curl -s "http://localhost:9696/v2.0/floatingips" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create floating IP
curl -s -X POST "http://localhost:9696/v2.0/floatingips" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"floatingip": {"floating_network_id": "{external_network_id}"}}' | jq

# Associate with port
curl -s -X PUT "http://localhost:9696/v2.0/floatingips/{floatingip_id}" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"floatingip": {"port_id": "{port_id}"}}' | jq

# Delete floating IP
curl -s -X DELETE "http://localhost:9696/v2.0/floatingips/{floatingip_id}" \
  -H "X-Auth-Token: $TOKEN"

Security Groups

# List security groups
curl -s "http://localhost:9696/v2.0/security-groups" \
  -H "X-Auth-Token: $TOKEN" | jq

# Create security group
curl -s -X POST "http://localhost:9696/v2.0/security-groups" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"security_group": {"name": "web-servers", "description": "Security group for web servers"}}' | jq

# Create rule (SSH)
curl -s -X POST "http://localhost:9696/v2.0/security-group-rules" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "security_group_rule": {
      "security_group_id": "{security_group_id}",
      "direction": "ingress",
      "protocol": "tcp",
      "port_range_min": 22,
      "port_range_max": 22,
      "remote_ip_prefix": "0.0.0.0/0"
    }
  }' | jq

# Create rule (HTTP)
curl -s -X POST "http://localhost:9696/v2.0/security-group-rules" \
  -H "X-Auth-Token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "security_group_rule": {
      "security_group_id": "{security_group_id}",
      "direction": "ingress",
      "protocol": "tcp",
      "port_range_min": 80,
      "port_range_max": 80,
      "remote_ip_prefix": "0.0.0.0/0"
    }
  }' | jq

# Delete rule
curl -s -X DELETE "http://localhost:9696/v2.0/security-group-rules/{rule_id}" \
  -H "X-Auth-Token: $TOKEN"

# Delete security group
curl -s -X DELETE "http://localhost:9696/v2.0/security-groups/{security_group_id}" \
  -H "X-Auth-Token: $TOKEN"

Limits and Quotas

# Nova limits
curl -s "http://localhost:8774/v2.1/limits" \
  -H "X-Auth-Token: $TOKEN" | jq

# Cinder limits
curl -s "http://localhost:8776/v3/$PROJECT_ID/limits" \
  -H "X-Auth-Token: $TOKEN" | jq

# Neutron quotas
curl -s "http://localhost:9696/v2.0/quotas/$PROJECT_ID" \
  -H "X-Auth-Token: $TOKEN" | jq

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Examples

Authentication

Get a Token

Get Project ID

Keystone (Identity)

Domains

Projects

Users

Roles

Groups

Nova (Compute)

Servers

Flavors

Keypairs

Cinder (Block Storage)

Volumes

Snapshots

Volume Types

Glance (Image)

Images

Image Sharing

Neutron (Networking)

Networks

Subnets

Ports

Routers

Floating IPs

Security Groups

Limits and Quotas

Related Documentation

FilesExpand file tree

api-examples.md

Latest commit

History

api-examples.md

File metadata and controls

API Examples

Authentication

Get a Token

Get Project ID

Keystone (Identity)

Domains

Projects

Users

Roles

Groups

Nova (Compute)

Servers

Flavors

Keypairs

Cinder (Block Storage)

Volumes

Snapshots

Volume Types

Glance (Image)

Images

Image Sharing

Neutron (Networking)

Networks

Subnets

Ports

Routers

Floating IPs

Security Groups

Limits and Quotas

Related Documentation