Delete a Service Instance
DELETE /v2/service_instances/:guid
Request
Route
DELETE /v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899?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.
|
|
|
|
purge
|
Recursively remove a service instance and child objects from Cloud Foundry database without making requests to a service broker.
The user must have the cloud_controller.admin scope on their OAuth token in order to perform a purge.
|
|
|
|
recursive
|
Will delete service bindings, service keys, and routes associated with the service instance.
|
|
|
|
async
|
Will run the delete request in a background job. Recommended: 'true'.
|
|
|
accepts_incomplete: true
Headers
cURL
curl "https://api.[your-domain.com]/v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899?accepts_incomplete=true" -d '' -X DELETE \
-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE3IiwiZW1haWwiOiJlbWFpbC0xN0Bzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDU4NTk5NDIxfQ.Zka-uSOrmBYl6CMuFhK3LTCdSnNFy0Gpu3ljyElEihk" \
-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
|
|
|
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": "01fbe333-2e0e-4332-b297-5081e3025899",
"url": "/v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899",
"created_at": "2016-03-14T22:30:21Z",
"updated_at": null
},
"entity": {
"name": "name-53",
"credentials": {
"creds-key-12": "creds-val-12"
},
"service_plan_guid": "d02eb59c-ad6a-4710-9286-a11ba94f2506",
"space_guid": "309231fb-f717-4921-8f3a-8e369ef08919",
"gateway_data": null,
"dashboard_url": null,
"type": "managed_service_instance",
"last_operation": {
"type": "delete",
"state": "in progress",
"description": "",
"updated_at": "2016-03-14T22:30:21Z",
"created_at": "2016-03-14T22:30:21Z"
},
"tags": [
"accounting",
"mongodb"
],
"space_url": "/v2/spaces/309231fb-f717-4921-8f3a-8e369ef08919",
"service_plan_url": "/v2/service_plans/d02eb59c-ad6a-4710-9286-a11ba94f2506",
"service_bindings_url": "/v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899/service_bindings",
"service_keys_url": "/v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899/service_keys",
"routes_url": "/v2/service_instances/01fbe333-2e0e-4332-b297-5081e3025899/routes"
}
}
Headers