Home
Version 3
Service Instances API

Service Instances API

List all Service Keys for the Service Instance

GET /v2/service_instances/:guid/service_keys

Request

Route

GET /v2/service_instances/b6a724e2-9580-4e60-becf-8ed796c09bf3/service_keys

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: name, space_guid, service_plan_guid, service_binding_guid, gateway_name, organization_guid, service_key_guid
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.zd4rBZD_uIArmAD38YaqPAl0FN7pf-fqOQdaDghY4Xs
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_instances/b6a724e2-9580-4e60-becf-8ed796c09bf3/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEwNyIsImVtYWlsIjoiZW1haWwtNzZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MzYxODcwOH0.zd4rBZD_uIArmAD38YaqPAl0FN7pf-fqOQdaDghY4Xs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a368f529-b16a-40c1-9b7c-9044824da364",
        "url": "/v2/service_keys/a368f529-b16a-40c1-9b7c-9044824da364",
        "created_at": "2016-05-12T00:45:08Z",
        "updated_at": null
      },
      "entity": {
        "name": "a-service-key",
        "service_instance_guid": "b6a724e2-9580-4e60-becf-8ed796c09bf3",
        "credentials": {
          "creds-key-7": "creds-val-7"
        },
        "service_instance_url": "/v2/service_instances/b6a724e2-9580-4e60-becf-8ed796c09bf3"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7f6ec54b-72ce-4d51-b653-a998c76df876
Content-Length: 648
X-Content-Type-Options: nosniff