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.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMCIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.gnIbXYcvyLMGonvjVrg5f1Yi6W_dnKRXNHNzVOa20-I
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIzMCIsImVtYWlsIjoiZW1haWwtMTQ4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzM5ODExMTB9.gnIbXYcvyLMGonvjVrg5f1Yi6W_dnKRXNHNzVOa20-I" \
	-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": "4798d757-abbe-4738-8661-fdf8e5a31bf3",
        "url": "/v2/service_keys/4798d757-abbe-4738-8661-fdf8e5a31bf3",
        "created_at": "2015-06-04T00:05:09Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-1556",
        "service_instance_guid": "2abb1ede-1ce6-4960-ab5d-fbfd543bb228",
        "credentials": {
          "creds-key-339": "creds-val-339"
        },
        "service_instance_url": "/v2/service_instances/2abb1ede-1ce6-4960-ab5d-fbfd543bb228"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c5136f6c-4bc5-4890-99ba-8662ca27d726
Content-Length: 648
X-Content-Type-Options: nosniff