Home
Version 3
Service Instances API

Service Instances API

Binding a Service Instance to a Route

PUT /v2/service_instances/:service_instance_guid/routes/:route_guid

Request

Route

PUT /v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437/routes/7cd7502f-3a88-4c27-a9ca-f33ba604a2e1

Body

Name Description Default Valid Values Example Values
parameters Arbitrary parameters to pass along to the service broker. Must be a JSON object.
{
  "parameters": {
    "the_service_broker": "wants this object"
  }
}

Headers

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

cURL

curl "https://api.[your-domain.com]/v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437/routes/7cd7502f-3a88-4c27-a9ca-f33ba604a2e1" -d '{
  "parameters": {
    "the_service_broker": "wants this object"
  }
}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwOSIsImVtYWlsIjoiZW1haWwtNzhAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.mRt_N97FxCyVsuZIzW_qljFDwWgxrJlRJq9sp537Y4g" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

201 Created

Body

{
  "metadata": {
    "guid": "305636a6-9eac-48a3-a913-b24fdcf12437",
    "url": "/v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437",
    "created_at": "2016-05-12T00:45:08Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-215",
    "credentials": {
      "creds-key-9": "creds-val-9"
    },
    "service_plan_guid": "2234a95b-4d7d-4c96-8348-e24bf50b4b40",
    "space_guid": "6c4eb3a4-549c-414c-acf2-530193cfcfdb",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": null,
    "tags": [

    ],
    "space_url": "/v2/spaces/6c4eb3a4-549c-414c-acf2-530193cfcfdb",
    "service_plan_url": "/v2/service_plans/2234a95b-4d7d-4c96-8348-e24bf50b4b40",
    "service_bindings_url": "/v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437/service_bindings",
    "service_keys_url": "/v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437/service_keys",
    "routes_url": "/v2/service_instances/305636a6-9eac-48a3-a913-b24fdcf12437/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: bfa27e92-a669-4d00-bc1b-400f0fc3e9fb
Content-Length: 1027
X-Content-Type-Options: nosniff

Audit Records Created By The Request

Audit Record: audit.service_instance.bind_route

Attribute Name Value
id 9
guid 7af15178-40fe-41b1-a09c-dcb57e7bc807
created_at 2016-05-12 00:45:08 UTC
updated_at
timestamp 2016-05-12 00:45:08 UTC
type audit.service_instance.bind_route
actor uaa-id-109
actor_type user
actee 305636a6-9eac-48a3-a913-b24fdcf12437
actee_type service_instance
metadata
{
  "request": {
    "route_guid": "7cd7502f-3a88-4c27-a9ca-f33ba604a2e1",
    "parameters": "[PRIVATE DATA HIDDEN]"
  }
}
space_id
organization_guid a8e3b26f-9a9c-450e-b1f1-87ebd324229c
space_guid 6c4eb3a4-549c-414c-acf2-530193cfcfdb
actor_name email-78@somedomain.com
actee_name name-215