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.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTB9.E-rHPjbFPgWl2724kOVr0hJ916dD1hQpnLQBpAKgthA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/service_keys" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI4OCIsImVtYWlsIjoiZW1haWwtMTk0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTB9.E-rHPjbFPgWl2724kOVr0hJ916dD1hQpnLQBpAKgthA" \
	-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": "313be21e-e412-427b-907d-23933f636625",
        "url": "/v2/service_keys/313be21e-e412-427b-907d-23933f636625",
        "created_at": "2015-12-22T18:28:10Z",
        "updated_at": null
      },
      "entity": {
        "name": "name-932",
        "service_instance_guid": "8787a181-a6e6-43d0-813c-039d7bbd53c3",
        "credentials": {
          "creds-key-424": "creds-val-424"
        },
        "service_instance_url": "/v2/service_instances/8787a181-a6e6-43d0-813c-039d7bbd53c3"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 647
X-Content-Type-Options: nosniff