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.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMyIsImVtYWlsIjoiZW1haWwtMTI3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NDV9.O3TVkOQ0AC7vt8ikx4TMvS4Yb3POjH8xXlAGTvPxZRg
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIyMyIsImVtYWlsIjoiZW1haWwtMTI3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDU1NTc5NDV9.O3TVkOQ0AC7vt8ikx4TMvS4Yb3POjH8xXlAGTvPxZRg" \
	-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": "6358b4e7-4d76-4459-b231-393f917d5c9a",
        "url": "/v2/service_keys/6358b4e7-4d76-4459-b231-393f917d5c9a",
        "created_at": "2015-10-15T23:52:25Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1503",
        "service_instance_guid": "2a103eb9-3377-4aab-aee3-1c3de4062b42",
        "credentials": {
          "creds-key-280": "creds-val-280"
        },
        "service_instance_url": "/v2/service_instances/2a103eb9-3377-4aab-aee3-1c3de4062b42"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 1205078c-6831-4eb5-a400-c234549055d1
Content-Length: 648
X-Content-Type-Options: nosniff