Home
Version 3
Shared Domains API

Shared Domains API

List all Shared Domains

GET /v2/shared_domains

Request

Route

GET /v2/shared_domains

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MDUwNjY0M30.LQCMs1kSUkS7u6yCl-6vEZ20B3HQzjDFpBBGjS1fthA
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyOSIsImVtYWlsIjoiZW1haWwtOThAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2MDUwNjY0M30.LQCMs1kSUkS7u6yCl-6vEZ20B3HQzjDFpBBGjS1fthA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 6,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a42283b0-7b63-49c9-9ea5-2a7e96ce0c60",
        "url": "/v2/shared_domains/a42283b0-7b63-49c9-9ea5-2a7e96ce0c60",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "1308e8d2-0fd4-41f1-a008-ec21e12b7639",
        "url": "/v2/shared_domains/1308e8d2-0fd4-41f1-a008-ec21e12b7639",
        "created_at": "2016-04-06T00:17:18Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "a37c3d6a-3d8b-43a3-987a-a9f5235a8c85",
        "url": "/v2/shared_domains/a37c3d6a-3d8b-43a3-987a-a9f5235a8c85",
        "created_at": "2016-04-06T00:17:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-38.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "a046be83-edde-4f9d-bda8-aa89eeaa8fad",
        "url": "/v2/shared_domains/a046be83-edde-4f9d-bda8-aa89eeaa8fad",
        "created_at": "2016-04-06T00:17:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-39.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "f3dd709f-5786-490c-b999-3c7038987092",
        "url": "/v2/shared_domains/f3dd709f-5786-490c-b999-3c7038987092",
        "created_at": "2016-04-06T00:17:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-40.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "5b855e1b-6378-4c39-b362-e5277682c4f6",
        "url": "/v2/shared_domains/5b855e1b-6378-4c39-b362-e5277682c4f6",
        "created_at": "2016-04-06T00:17:23Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com",
        "router_group_guid": "my-random-guid",
        "router_group_type": "tcp"
      }
    }
  ]
}

Headers

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