Home
Version 3
Service Instances API

Service Instances API

Binding a service instance to a route (experimental)

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

Request

Route

PUT /v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f/routes/7669ed9b-1278-403f-8507-806f550941bd
{}

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDd9.M-nfQguVfOT7WzOGHmuU3zWHBhLdEUeMmhm_G4EmtVI
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f/routes/7669ed9b-1278-403f-8507-806f550941bd" -d '{}' -X PUT \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NSIsImVtYWlsIjoiZW1haWwtMTgxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MDd9.M-nfQguVfOT7WzOGHmuU3zWHBhLdEUeMmhm_G4EmtVI" \
	-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.
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": "1058f08a-6484-4a45-b08e-9eee4000e73f",
    "url": "/v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f",
    "created_at": "2015-08-31T21:50:07Z",
    "updated_at": null
  },
  "entity": {
    "name": "name-950",
    "credentials": {
      "creds-key-397": "creds-val-397"
    },
    "service_plan_guid": "776c74df-967c-49e4-9941-9651e0ad7709",
    "space_guid": "407d7502-ec52-4c53-a601-56788ec4bfac",
    "gateway_data": null,
    "dashboard_url": null,
    "type": "managed_service_instance",
    "last_operation": {
      "type": "create",
      "state": "succeeded",
      "description": "service broker-provided description",
      "updated_at": "2015-08-31T21:50:07Z",
      "created_at": "2015-08-31T21:50:07Z"
    },
    "tags": [
      "accounting",
      "mongodb"
    ],
    "space_url": "/v2/spaces/407d7502-ec52-4c53-a601-56788ec4bfac",
    "service_plan_url": "/v2/service_plans/776c74df-967c-49e4-9941-9651e0ad7709",
    "service_bindings_url": "/v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f/service_bindings",
    "service_keys_url": "/v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f/service_keys",
    "routes_url": "/v2/service_instances/1058f08a-6484-4a45-b08e-9eee4000e73f/routes"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d5778001-a75d-42db-a300-a4536a10aae1
Content-Length: 1268
X-Content-Type-Options: nosniff