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
tags A list of tags for the service instance. Max characters: 2048 []
  • ["db"]
  • ["accounting", "mongodb"]
{
  "space_guid": "bbde8b4a-e070-4937-9095-e56bd28bd1c4",
  "name": "my-service-instance",
  "service_plan_guid": "907756ec-534a-4461-b799-7dd2e239d58e",
  "parameters": {
    "the_service_broker": "wants this object"
  },
  "tags": [
    "accounting",
    "mongodb"
  ]
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY1IiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUxNDEzNjc3fQ.sevXXMdskvabPQ1tcFl9pU4ejnNvpR7h7Y-qPqmJacM
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": "bbde8b4a-e070-4937-9095-e56bd28bd1c4",
  "name": "my-service-instance",
  "service_plan_guid": "907756ec-534a-4461-b799-7dd2e239d58e",
  "parameters": {
    "the_service_broker": "wants this object"
  },
  "tags": [
    "accounting",
    "mongodb"
  ]
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTY1IiwiZW1haWwiOiJlbWFpbC0zM0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDUxNDEzNjc3fQ.sevXXMdskvabPQ1tcFl9pU4ejnNvpR7h7Y-qPqmJacM" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

202 Accepted

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.
routes_url Routes bound to the service instance. Requests to these routes will be forwarded to the service instance.
tags A list of tags for the service instance
{
  "metadata": {
    "guid": "67bfe43b-1dcd-4580-8802-244345a90259",
    "url": "/v2/service_instances/67bfe43b-1dcd-4580-8802-244345a90259",
    "created_at": "2015-12-22T18:27:57Z",
    "updated_at": null
  },
  "entity": {
    "name": "my-service-instance",
    "credentials": {

    },
    "service_plan_guid": "907756ec-534a-4461-b799-7dd2e239d58e",
    "space_guid": "bbde8b4a-e070-4937-9095-e56bd28bd1c4",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "in progress",
      "description": "",
      "updated_at": null,
      "created_at": "2015-12-22T18:27:57Z"
    },
    "tags": [
      "accounting",
      "mongodb"
    ],
    "space_url": "/v2/spaces/bbde8b4a-e070-4937-9095-e56bd28bd1c4",
    "service_plan_url": "/v2/service_plans/907756ec-534a-4461-b799-7dd2e239d58e",
    "service_bindings_url": "/v2/service_instances/67bfe43b-1dcd-4580-8802-244345a90259/service_bindings",
    "service_keys_url": "/v2/service_instances/67bfe43b-1dcd-4580-8802-244345a90259/service_keys",
    "routes_url": "/v2/service_instances/67bfe43b-1dcd-4580-8802-244345a90259/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/service_instances/67bfe43b-1dcd-4580-8802-244345a90259
X-VCAP-Request-ID: 
Content-Length: 1190
X-Content-Type-Options: nosniff