Home
Version 3
Services API

Services API

Delete a Particular Service

DELETE /v2/services/:guid

Request

Route

DELETE /v2/services/5f199e9a-c5b3-478b-977e-00fd5b1bcfb1

Parameters

Name Description Valid Values Example Values
async Will run the delete request in a background job. Recommended: 'true'.
purge Recursively remove a service and child objects from Cloud Foundry database without making requests to a service broker

Body

Name Description Default Valid Values Example Values
guid The guid of the service
label The name of the service
  • SomeMysqlService
description A short blurb describing the service
  • Mysql stores things for you
long_description A longer description of the service
  • Mysql is a database. It stores things. Use it in your apps...
info_url A url that points to an info page for the service
  • http://info.somemysqlservice.com
documentation_url A url that points to a documentation page for the service
  • http://docs.somemysqlservice.com
timeout A timeout used by the v1 service gateway client
active A boolean describing that the service can be provisioned by users false
bindable A boolean describing that the service can be bound to applications true
extra A JSON field with extra data pertaining to the service
  • {"providerDisplayName": "MyServiceProvider"}
unique_id A guid that identifies the service with the broker (not the same as the guid above)
tags A list of tags for the service []
  • database
  • mysql
requires A list of dependencies for services. The presence of "syslog_drain" indicates that on binding an instance of the service to an application, logs for the app will be streamed to a url provided by the service. The presence of "route_forwarding" indicates that on binding an instance of the service to a route, requests for the route may be processed by the service before being forwarded to an application mapped to the route. []
  • syslog_drain
  • route_forwarding
provider The name of the service provider (used only by v1 service gateways)
  • MySql Provider
version The version of the service (used only by v1 service gateways)
  • 2.0
url The url of ther service provider (used only by v1 service gateways)
  • http://myql.provider.com
service_broker_guid The guid of the v2 service broker associated with the service
plan_updateable A boolean describing that an instance of this service can be updated to a different plan false

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjF9.O2iZR8lnKknT43wl0hDs-UoV4nqUxQja1D6ddVnv9Dw
Host: example.org
Content-Type: application/x-www-form-urlencoded
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/services/5f199e9a-c5b3-478b-977e-00fd5b1bcfb1" -d '' -X DELETE \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMSIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NjF9.O2iZR8lnKknT43wl0hDs-UoV4nqUxQja1D6ddVnv9Dw" \
	-H "Host: example.org" \
	-H "Content-Type: application/x-www-form-urlencoded" \
	-H "Cookie: "

Response

Status

204 No Content

Headers

X-VCAP-Request-ID: 399fb0b7-4b9b-4eb3-9497-70a398541df3
X-Content-Type-Options: nosniff