Home
Version 3
Service Keys API

Service Keys API

List all Service Keys

GET /v2/service_keys

Request

Route

GET /v2/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, service_instance_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.eyJ1c2VyX2lkIjoidWFhLWlkLTI1IiwiZW1haWwiOiJlbWFpbC0yNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgzfQ.N3RHttsomrKfpxrGFkbikX9XfssJEVE6365pchayvN0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1IiwiZW1haWwiOiJlbWFpbC0yNUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDY2MDA4ODgzfQ.N3RHttsomrKfpxrGFkbikX9XfssJEVE6365pchayvN0" \
	-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": "67755c27-28ed-4087-9688-c07d92f3bcc9",
        "url": "/v2/service_keys/67755c27-28ed-4087-9688-c07d92f3bcc9",
        "created_at": "2016-06-08T16:41:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-166",
        "service_instance_guid": "888f0f72-3603-4f66-97f3-4b66b559f908",
        "credentials": {
          "creds-key-13": "creds-val-13"
        },
        "service_instance_url": "/v2/service_instances/888f0f72-3603-4f66-97f3-4b66b559f908"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0b880284-ead9-4470-a07e-679013bb9f07
Content-Length: 645
X-Content-Type-Options: nosniff