Shared Domains API

Filtering Shared Domains by name

GET /v2/shared_domains

Fields

Name	Description	Default	Valid Values	Example Values
guid	The guid of the domain.
name	The name of the domain.			example.com foo.example.com

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		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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNCIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.kDLWFxN7KHE7QhSui6hhmGmyEMweH_5N9Ykk1xq-X_s
Host: example.org
Cookie: 

Route

GET /v2/shared_domains

Query Parameters

q: name:shared-domain.com

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExNCIsImVtYWlsIjoiZW1haWwtODRAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.kDLWFxN7KHE7QhSui6hhmGmyEMweH_5N9Ykk1xq-X_s" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0f4cf2d0-fce6-44dc-8c83-e72964c4c30e
Content-Length: 412
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a5cbc3a8-9d19-4b3e-91b3-edc26fc33ebc",
        "url": "/v2/shared_domains/a5cbc3a8-9d19-4b3e-91b3-edc26fc33ebc",
        "created_at": "2015-01-27T19:14:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "shared-domain.com"
      }
    }
  ]
}