Home
Version 3
Services API

Services API

Retrieve a Particular Service

GET /v2/services/:guid

Request

Route

GET /v2/services/9ab17246-1621-42f8-b1bb-1a85f60e2e2b

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. Max characters: 2048 []
  • 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.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOSIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM3MDB9.dTO1n78Ms70Q4uMXnrwnSIL1Mo9HVx6mZZVSAYKJLm0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/services/9ab17246-1621-42f8-b1bb-1a85f60e2e2b" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQyOSIsImVtYWlsIjoiZW1haWwtMzAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM3MDB9.dTO1n78Ms70Q4uMXnrwnSIL1Mo9HVx6mZZVSAYKJLm0" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "metadata": {
    "guid": "9ab17246-1621-42f8-b1bb-1a85f60e2e2b",
    "url": "/v2/services/9ab17246-1621-42f8-b1bb-1a85f60e2e2b",
    "created_at": "2015-12-22T18:28:20Z",
    "updated_at": null
  },
  "entity": {
    "label": "label-86",
    "provider": null,
    "url": null,
    "description": "desc-174",
    "long_description": null,
    "version": null,
    "info_url": null,
    "active": true,
    "bindable": true,
    "unique_id": "24eef458-f6ed-45f4-b48c-e713a28bcb89",
    "extra": null,
    "tags": [

    ],
    "requires": [

    ],
    "documentation_url": null,
    "service_broker_guid": "9d087825-68e3-436a-8846-b22f6f1fdd90",
    "plan_updateable": false,
    "service_plans_url": "/v2/services/9ab17246-1621-42f8-b1bb-1a85f60e2e2b/service_plans"
  }
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 776
X-Content-Type-Options: nosniff