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.eyJ1c2VyX2lkIjoidWFhLWlkLTIiLCJlbWFpbCI6ImVtYWlsLTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQyMH0.iese537-X9MmMVdtrY_sPmmAtQRuBaEr_wvbDA-Gm7o
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIiLCJlbWFpbCI6ImVtYWlsLTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ1ODU5OTQyMH0.iese537-X9MmMVdtrY_sPmmAtQRuBaEr_wvbDA-Gm7o" \
	-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": "14f4071d-7306-4b12-a3e4-f9018f835cb7",
        "url": "/v2/shared_domains/14f4071d-7306-4b12-a3e4-f9018f835cb7",
        "created_at": "2016-03-14T22:30:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "db361df6-4b1d-419c-b632-05f17d726644",
        "url": "/v2/shared_domains/db361df6-4b1d-419c-b632-05f17d726644",
        "created_at": "2016-03-14T22:30:19Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "1454973c-da78-4eae-94fb-b8e558764f32",
        "url": "/v2/shared_domains/1454973c-da78-4eae-94fb-b8e558764f32",
        "created_at": "2016-03-14T22:30:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-1.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "6032acce-66dd-4743-ba92-03142dcf680b",
        "url": "/v2/shared_domains/6032acce-66dd-4743-ba92-03142dcf680b",
        "created_at": "2016-03-14T22:30:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-2.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "1605b49e-9f3d-494f-aba2-9d75f40a78dd",
        "url": "/v2/shared_domains/1605b49e-9f3d-494f-aba2-9d75f40a78dd",
        "created_at": "2016-03-14T22:30:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-3.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "05673e8d-97c8-4dc6-b098-82bbc39d7fb0",
        "url": "/v2/shared_domains/05673e8d-97c8-4dc6-b098-82bbc39d7fb0",
        "created_at": "2016-03-14T22:30:20Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-4.example.com",
        "router_group_guid": "my-random-guid",
        "router_group_types": [
          "tcp"
        ]
      }
    }
  ]
}

Headers

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