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

Body

Name Description Default Valid Values Example Values

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MyIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDB9.xp96xwYxWFTFHGLQr90vg2Xbmz-HJ-a70M56UQUYw5Y
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MyIsImVtYWlsIjoiZW1haWwtMTE1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0Mjk2NjQxNDB9.xp96xwYxWFTFHGLQr90vg2Xbmz-HJ-a70M56UQUYw5Y" \
	-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": "3b9392ee-6f12-4cf9-983a-bfb8152ccbcd",
        "url": "/v2/service_keys/3b9392ee-6f12-4cf9-983a-bfb8152ccbcd",
        "created_at": "2015-04-15T00:55:40Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1302",
        "service_instance_guid": "9a7d0ee1-6bd1-4e09-9c37-d4e29e84552d",
        "credentials": {
          "creds-key-267": "creds-val-267"
        },
        "service_instance_url": "/v2/service_instances/9a7d0ee1-6bd1-4e09-9c37-d4e29e84552d"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 6dc0ea5e-1b4c-4c52-9313-95c7ff4ad6e0
Content-Length: 648
X-Content-Type-Options: nosniff