Welcome to openbrokerapi’s documentation!

Contents:

• Getting Started
  • Installation
  • Usage
  • Deployment
  • Error Types
  • Bugs or Issues
  • How to contribute
• Overview
  • Scenarios
    • Provide one or more services with one broker
    • Separate implementations as independent brokers
• Full Example
• Changelog
• Package API
  • Api module
    • get_blueprint()
    • serve()
    • serve_multiple()
  • Catalog module
    • Schemas
    • ServiceDashboardClient
    • ServiceMetadata
    • ServicePlan
    • ServicePlanCost
    • ServicePlanMetadata
  • Log_util module
    • basic_config()
  • Response module
    • AsyncResponse
    • BindResponse
    • CatalogResponse
    • DeprovisionResponse
    • EmptyResponse
    • ErrorResponse
    • GetBindingResponse
    • GetInstanceResponse
    • LastOperationResponse
    • ProvisioningResponse
    • UnbindResponse
    • UpdateResponse
  • Service_broker module
    • BindDetails
      • BindDetails.authorization_username
      • BindDetails.originating_identity
    • BindResource
    • BindState
      • BindState.IDENTICAL_ALREADY_EXISTS
      • BindState.IS_ASYNC
      • BindState.SUCCESSFUL_BOUND
    • Binding
    • DeprovisionDetails
      • DeprovisionDetails.authorization_username
      • DeprovisionDetails.originating_identity
    • DeprovisionServiceSpec
    • GetBindingSpec
    • GetInstanceDetailsSpec
    • LastOperation
    • OperationState
      • OperationState.FAILED
      • OperationState.IN_PROGRESS
      • OperationState.SUCCEEDED
    • PreviousValues
    • ProvisionDetails
      • ProvisionDetails.authorization_username
      • ProvisionDetails.originating_identity
    • ProvisionState
      • ProvisionState.IDENTICAL_ALREADY_EXISTS
      • ProvisionState.IS_ASYNC
      • ProvisionState.SUCCESSFUL_CREATED
    • ProvisionedServiceSpec
      • ProvisionedServiceSpec.is_async
    • Service
    • ServiceBroker
      • ServiceBroker.bind()
      • ServiceBroker.catalog()
      • ServiceBroker.deprovision()
      • ServiceBroker.get_binding()
      • ServiceBroker.get_instance()
      • ServiceBroker.last_binding_operation()
      • ServiceBroker.last_operation()
      • ServiceBroker.provision()
      • ServiceBroker.unbind()
      • ServiceBroker.update()
    • SharedDevice
    • UnbindDetails
      • UnbindDetails.authorization_username
      • UnbindDetails.originating_identity
    • UnbindSpec
    • UpdateDetails
      • UpdateDetails.authorization_username
      • UpdateDetails.originating_identity
    • UpdateServiceSpec
    • VolumeMount
  • Authentication
    • Authenticator
    • BasicAuthenticator
    • BasicBrokerAuthenticator
      • BasicBrokerAuthenticator.authenticate()
    • BrokerAuthenticator
      • BrokerAuthenticator.authenticate()
    • BrokerCredentials
    • NoneAuthenticator
    • NoneBrokerAuthenticator
      • NoneBrokerAuthenticator.authenticate()
  • Errors module
    • ErrAppGuidNotProvided
    • ErrAsyncRequired
    • ErrBadRequest
    • ErrBindingAlreadyExists
    • ErrBindingDoesNotExist
    • ErrConcurrentInstanceAccess
    • ErrInstanceAlreadyExists
    • ErrInstanceDoesNotExist
    • ErrInstanceLimitMet
    • ErrInvalidParameters
    • ErrPlanChangeNotSupported
    • ErrPlanQuotaExceeded
    • ErrServiceQuotaExceeded
    • ServiceException

Indices and tables

• Index

• Module Index

• Search Page