Service Instances API

List all Service Keys for the Service Instance

GET /v2/service_instances/:guid/service_keys

Request

Route

GET /v2/service_instances/b9656309-d994-4dec-a71f-8eac6e2fc7dc/service_keys

Parameters

Name	Description	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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NCIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.CvSyQKxj6O5L8Wm2FhemhlR0PmE4o3nlMuPgdssibYU
Host: example.org
Cookie:

cURL

curl "https://api.[your-domain.com]/v2/service_instances/b9656309-d994-4dec-a71f-8eac6e2fc7dc/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1NCIsImVtYWlsIjoiZW1haWwtMTA5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTB9.CvSyQKxj6O5L8Wm2FhemhlR0PmE4o3nlMuPgdssibYU" \
	-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": "77b6e30c-e118-4d12-807e-7fc421482e1d",
        "url": "/v2/service_keys/77b6e30c-e118-4d12-807e-7fc421482e1d",
        "created_at": "2016-06-08T16:41:30Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "name": "a-service-key",
        "service_instance_guid": "b9656309-d994-4dec-a71f-8eac6e2fc7dc",
        "credentials": {
          "creds-key-43": "creds-val-43"
        },
        "service_instance_url": "/v2/service_instances/b9656309-d994-4dec-a71f-8eac6e2fc7dc",
        "service_key_parameters_url": "/v2/service_keys/77b6e30c-e118-4d12-807e-7fc421482e1d/parameters"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c78c908d-5a35-4787-9ae3-e6c4dfac820d
Content-Length: 650
X-Content-Type-Options: nosniff