Home
Version 3
Service Instances API

Service Instances API

Creating a Service Instance

POST /v2/service_instances/

Request

Route

POST /v2/service_instances?accepts_incomplete=true

Parameters

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

Body

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": "1b017a11-79ab-42be-bc81-8320e0bbf617",
  "name": "my-service-instance",
  "service_plan_guid": "f3dfb875-c533-4999-bdbc-71a1ac07844d",
  "parameters": {
    "the_service_broker": "wants this object"
  }
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEiLCJlbWFpbCI6ImVtYWlsLTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4NzczM30.PwceSoeGVfSm5jau3sw5GlxjIbTdMBxnqJLjMaOwcbU
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances?accepts_incomplete=true" -d '{
  "space_guid": "1b017a11-79ab-42be-bc81-8320e0bbf617",
  "name": "my-service-instance",
  "service_plan_guid": "f3dfb875-c533-4999-bdbc-71a1ac07844d",
  "parameters": {
    "the_service_broker": "wants this object"
  }
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEiLCJlbWFpbCI6ImVtYWlsLTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNjE4NzczM30.PwceSoeGVfSm5jau3sw5GlxjIbTdMBxnqJLjMaOwcbU" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

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.
gateway_data
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": "84191fff-cbd4-4c84-ba42-a4639c13d5e3",
    "url": "/v2/service_instances/84191fff-cbd4-4c84-ba42-a4639c13d5e3",
    "created_at": "2015-03-05T19:15:32Z",
    "updated_at": null
  },
  "entity": {
    "name": "my-service-instance",
    "credentials": {
      "creds-key-1": "creds-val-1"
    },
    "service_plan_guid": "f3dfb875-c533-4999-bdbc-71a1ac07844d",
    "space_guid": "1b017a11-79ab-42be-bc81-8320e0bbf617",
    "gateway_data": "CONFIGURATION",
    "dashboard_url": "http://dashboard.example.com",
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "succeeded",
      "description": "",
      "updated_at": "2015-03-05T19:15:32Z"
    },
    "space_url": "/v2/spaces/1b017a11-79ab-42be-bc81-8320e0bbf617",
    "service_plan_url": "/v2/service_plans/f3dfb875-c533-4999-bdbc-71a1ac07844d",
    "service_bindings_url": "/v2/service_instances/84191fff-cbd4-4c84-ba42-a4639c13d5e3/service_bindings"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/service_instances/84191fff-cbd4-4c84-ba42-a4639c13d5e3
X-VCAP-Request-ID: 349469db-5b23-4f02-955a-06c88e91afd3
Content-Length: 990
X-Content-Type-Options: nosniff