Version 3
Service Instances API

Service Instances API

Creating a Service Instance

POST /v2/service_instances/



POST /v2/service_instances?accepts_incomplete=true


Name Description Valid Values Example Values
accepts_incomplete Set to `true` if the client allows asynchronous provisioning. The cloud controller may respond before the service is ready for use.
  • true
  • false
accepts_incomplete: true


Name Description Default Valid Values Example Values
name A name for the service instance
  • my-service-instance
service_plan_guid The guid of the service plan to associate with the instance
space_guid The guid of the space in which the instance will be created
parameters Arbitrary parameters to pass along to the service broker. Must be a JSON object
gateway_data Configuration information for the broker gateway in v1 services
  "space_guid": "9d3b5adb-14e5-4659-a8c6-785aacbb9bd5",
  "name": "my-service-instance",
  "service_plan_guid": "3710a39b-d087-41a1-902c-a4986fce110c",
  "parameters": {
    "the_service_broker": "wants this object"


Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODR9.Z3JPMuMrMOJRqvwprkeDmrbtrW8qWgs5NoAZaSkg8nE
Host: example.org
Content-Type: application/x-www-form-urlencoded


curl "https://api.[your-domain.com]/v2/service_instances?accepts_incomplete=true" -d '{
  "space_guid": "9d3b5adb-14e5-4659-a8c6-785aacbb9bd5",
  "name": "my-service-instance",
  "service_plan_guid": "3710a39b-d087-41a1-902c-a4986fce110c",
  "parameters": {
    "the_service_broker": "wants this object"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5ODR9.Z3JPMuMrMOJRqvwprkeDmrbtrW8qWgs5NoAZaSkg8nE" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "



202 Accepted


Name Description Valid Values
name The human-readable name of the service instance.
credentials The service broker-provided credentials to use this service.
service_plan_guid The service plan GUID that this service instance is utilizing.
space_guid The space GUID that this service instance belongs to.
dashboard_url The service broker-provided URL to access administrative features of the service instance. May be null.
type The type of service instance.
  • managed_service_instance
  • user_provided_service_instance
last_operation The status of the last operation requested on the service instance. May be null.
last_operation.type The type of operation that was last performed or currently being performed on the service instance
  • create
  • update
  • delete
last_operation.state The status of the last operation or current operation being performed on the service instance.
  • in progress
  • succeeded
  • failed
last_operation.description The service broker-provided description of the operation. May be null.
last_operation.updated_at The timestamp that the Cloud Controller last checked the service instance state from the broker.
space_url The relative path to the space resource that this service instance belongs to.
service_plan_url The relative path to the service plan resource that this service instance belongs to.
service_binding_url The relative path to the service bindings that this service instance is bound to.
  "metadata": {
    "guid": "5b696123-d38c-4754-ab8d-223c1fdf3188",
    "url": "/v2/service_instances/5b696123-d38c-4754-ab8d-223c1fdf3188",
    "created_at": "2015-05-21T01:03:04Z",
    "updated_at": null
  "entity": {
    "name": "my-service-instance",
    "credentials": {

    "service_plan_guid": "3710a39b-d087-41a1-902c-a4986fce110c",
    "space_guid": "9d3b5adb-14e5-4659-a8c6-785aacbb9bd5",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "in progress",
      "description": "",
      "updated_at": "2015-05-21T01:03:04Z",
      "created_at": "2015-05-21T01:03:04Z"
    "space_url": "/v2/spaces/9d3b5adb-14e5-4659-a8c6-785aacbb9bd5",
    "service_plan_url": "/v2/service_plans/3710a39b-d087-41a1-902c-a4986fce110c",
    "service_bindings_url": "/v2/service_instances/5b696123-d38c-4754-ab8d-223c1fdf3188/service_bindings",
    "service_keys_url": "/v2/service_instances/5b696123-d38c-4754-ab8d-223c1fdf3188/service_keys"


Content-Type: application/json;charset=utf-8
Location: /v2/service_instances/5b696123-d38c-4754-ab8d-223c1fdf3188
X-VCAP-Request-ID: a906a996-520c-4e96-9eb1-8e4f1ac41363
Content-Length: 1064
X-Content-Type-Options: nosniff