User Provided Service Instances API

Creating a User Provided Service Instance

POST /v2/user_provided_service_instances/

Request

Route

POST /v2/user_provided_service_instances

Body

Name	Description	Example Values
name	A name for the service instance	my-user-provided-instance
space_guid	The guid of the space in which the instance will be created
syslog_drain_url	URL to which logs will be streamed for bound applications.	syslog://example.com
credentials	A hash exposed in the VCAP_SERVICES environment variable for bound applications.	{:somekey=>"somevalue"}
route_service_url	URL to which requests for bound routes will be forwarded.	https://logger.example.com

{
  "space_guid": "260dd81d-14c0-4f27-8c9e-de86c76903f5",
  "name": "my-user-provided-instance",
  "credentials": {
    "somekey": "somevalue"
  },
  "syslog_drain_url": "syslog://example.com",
  "route_service_url": "https://logger.example.com"
}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1Mzd9.6Bi0RTMHaPs-7J84aS7Dv95ulY7_A1mZSKspoNpmL5k
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/user_provided_service_instances" -d '{
  "space_guid": "260dd81d-14c0-4f27-8c9e-de86c76903f5",
  "name": "my-user-provided-instance",
  "credentials": {
    "somekey": "somevalue"
  },
  "syslog_drain_url": "syslog://example.com",
  "route_service_url": "https://logger.example.com"
}' -X POST \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4NyIsImVtYWlsIjoiZW1haWwtMjg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDk1MzE1Mzd9.6Bi0RTMHaPs-7J84aS7Dv95ulY7_A1mZSKspoNpmL5k" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "77b6de52-0fb5-469f-b303-feaa04e9f3e6",
    "url": "/v2/user_provided_service_instances/77b6de52-0fb5-469f-b303-feaa04e9f3e6",
    "created_at": "2015-11-30T23:38:57Z",
    "updated_at": null
  },
  "entity": {
    "name": "my-user-provided-instance",
    "credentials": {
      "somekey": "somevalue"
    },
    "space_guid": "260dd81d-14c0-4f27-8c9e-de86c76903f5",
    "type": "user_provided_service_instance",
    "syslog_drain_url": "syslog://example.com",
    "route_service_url": "https://logger.example.com",
    "space_url": "/v2/spaces/260dd81d-14c0-4f27-8c9e-de86c76903f5",
    "service_bindings_url": "/v2/user_provided_service_instances/77b6de52-0fb5-469f-b303-feaa04e9f3e6/service_bindings",
    "routes_url": "/v2/user_provided_service_instances/77b6de52-0fb5-469f-b303-feaa04e9f3e6/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
Location: /v2/user_provided_service_instances/77b6de52-0fb5-469f-b303-feaa04e9f3e6
X-VCAP-Request-ID: 
Content-Length: 840
X-Content-Type-Options: nosniff