Welcome to the OpenStack SDK for PHP!

About

OpenStack SDK allows PHP developers to easily connect to OpenStack APIs in a simple and idiomatic way. This binding is specifically designed for OpenStack APIs, but other provider SDKs are available. Multiple OpenStack services, and versions of services, are supported.

• Installation
  • Requirements
  • Install via composer
  • Include autoloader
• Setup
  • Authenticate
    • By username
    • By user ID
    • By application credential ID
    • By token ID
  • Other options

Supported services

• Block Storage v2
• Block Storage v3
  • Create Service
  • Volumes
    • Create
      • Create from image
      • Create from snapshot
      • Create from volume
    • Read
    • Update
    • Delete
    • List
      • Detailed information
  • Volume Types
    • Create
    • Read
    • Update
    • Delete
    • List
  • Snapshots
    • List
      • List sorted
• Compute v2
  • Create Service
  • Servers
    • List
      • Detailed information
      • Filtering collections
    • Create
      • Security groups
      • Networks
      • External devices and boot from volume
      • Personality files
      • Metadata
    • Read
    • Update
    • Delete
    • Retrieve metadata
    • Reset metadata
    • Merge metadata
    • Retrieve metadata item
    • Delete metadata item
    • Change root password
    • Reset server state
    • Reboot server
    • Rebuild server
    • Resize server
    • Confirm server resize
    • Revert server resize
    • Create server image
    • List server IP addresses
    • Suspend
    • Resume
  • Volume Attachments
    • Create
    • Delete
    • List
  • Flavors
    • Read
    • List
      • Detailed information
  • Images
    • List images
      • Detailed information
    • Retrieve an image
    • Delete an image
    • Retrieve metadata
    • Reset metadata
    • Merge metadata
    • Retrieve image metadata item
    • Delete image metadata item
  • Server states
• Identity v2
• Identity v3
  • Create Service
  • Application Credentials
    • Create
    • Read
    • Delete
  • Credentials
    • Create
    • Read
    • Update
    • Delete
    • List
  • Domains
    • Create
    • Read
    • Update
    • Delete
    • List
    • List roles for domain user
    • Grant role to domain user
    • Check role for domain user
    • Revoke role for domain user
    • List roles for domain group
    • Grant role to domain group
    • Check role for domain group
    • Revoke role for domain group
  • Endpoints
    • Create
    • Read
    • Update
    • Delete
    • List
  • Groups
    • Create
    • Read
    • Update
    • Delete
    • List
    • List users in a group
    • Add user to group
    • Remove user from group
    • Check user membership in a group
  • Policies
  • Projects
    • Create
    • Read
    • Update
    • Delete
    • List
    • List roles for project user
    • Grant role to project user
    • Check role for project user
    • Revoke role for project user
    • List roles for project group
    • Grant role to project group
    • Check role for project group
    • Revoke role for project group
  • Roles
    • Create
    • List
    • List role assignments
  • Services
    • Create
    • Read
    • Update
    • Delete
    • List
  • Tokens
    • Generate token
      • Generate token with user ID
      • Generate token with username
      • Generate token with application credential ID
      • Generate token from ID
      • Generate token scoped to project ID
      • Generate token scoped to project name
    • Validate token
    • Revoke token
    • Cache authentication token
      • Use case
      • Generate token and persist to file
      • Initialize Open Stack using cached authentication token
  • Users
    • Create
    • Read
    • Update
    • Delete
    • List
    • List groups for user
    • List projects for user
• Images v2
  • Create Service
  • Images
    • Create
    • Read
    • Update
    • Delete
    • List
      • List images sorted
    • Reactivate
    • Deactivate
    • Upload binary data
    • Download binary data
  • Image Members
    • Create
    • Read
    • Delete
    • List
    • Update Status
• Networking v2
  • Create Service
  • Networks
    • Create
      • Batch
    • Read
    • Update
    • Delete
  • Subnets
    • Create
      • With gateway IP
      • With host routes
    • Read
    • Update
    • Delete
  • Ports
    • Create
      • Batch
    • Read
    • Update
    • Delete
  • LoadBalancers
    • Create
    • Read
    • Update
    • Delete
    • List
    • Add Listener
    • Get Stats
    • Get Status Tree
  • LoadBalancer Pools
    • Create
    • Read
    • List
    • Update
    • Delete
    • Add Member
    • Get Member
    • Delete Member
    • Add Health Monitor
  • LoadBalancer Listeners
    • Create
    • Read
    • Update
    • Delete
    • List
  • LoadBalancer HealthMonitors
    • Create
    • Read
    • Update
    • Delete
    • List
• Object Store v1
  • Create Service
  • Account
    • Read
    • Get account metadata
    • Replace all metadata with new values
    • Merge new metadata values with existing
  • Containers
    • Read
    • Delete
    • List
    • Get metadata
    • Replace all metadata with new values
    • Merge new metadata values with existing
  • Objects
    • Create
      • Create a large object (over 5GB)
    • Read
    • Delete
    • List
    • Download an object
    • Copy object
    • Get metadata
    • Replace all metadata with new values
    • Merge new metadata values with existing

Help and support

If you have specific problems or bugs with this SDK, please file an issue on our official Github repo.

Contributing

If you’d like to contribute to the project, or require help running the unit/integration tests, please view the contributing guidelines.