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.

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE1OCIsImVtYWlsIjoiZW1haWwtMTIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzh9.VKN_c6jPYKJvhK2tY7QiMc4AFTxUNSlS6fP4ZSjB-WA
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.eyJ1c2VyX2lkIjoidWFhLWlkLTE1OCIsImVtYWlsIjoiZW1haWwtMTIxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MTU3NTQxMzh9.VKN_c6jPYKJvhK2tY7QiMc4AFTxUNSlS6fP4ZSjB-WA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: c70f2312-3bde-4891-997d-cecc4a231f0e
Content-Length: 417
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "bc86b072-8f06-4d4f-a0de-9884f00ce010",
        "url": "/v2/shared_domains/bc86b072-8f06-4d4f-a0de-9884f00ce010",
        "created_at": "2014-11-05T01:02:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "shared-domain.com"
      }
    }
  ]
}