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.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NCIsImVtYWlsIjoiZW1haWwtMTEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTgzOTd9.Dd1tKHfyigNJCFJU3avdpcQjIUJWO2HbsAUEU6ReRkk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0NCIsImVtYWlsIjoiZW1haWwtMTEyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTgzOTd9.Dd1tKHfyigNJCFJU3avdpcQjIUJWO2HbsAUEU6ReRkk" \
	-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": "4f6e6f6e-695a-44df-816b-3d48ec05702b",
        "url": "/v2/shared_domains/4f6e6f6e-695a-44df-816b-3d48ec05702b",
        "created_at": "2016-04-22T19:33:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "43c8f83f-95b4-46fe-94cc-7748565d9a2b",
        "url": "/v2/shared_domains/43c8f83f-95b4-46fe-94cc-7748565d9a2b",
        "created_at": "2016-04-22T19:33:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "791bb463-06d9-4b3f-8acf-1f70ffc66e6f",
        "url": "/v2/shared_domains/791bb463-06d9-4b3f-8acf-1f70ffc66e6f",
        "created_at": "2016-04-22T19:33:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-32.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "c2c37a7b-1ef8-497c-b751-f8cf991f2c18",
        "url": "/v2/shared_domains/c2c37a7b-1ef8-497c-b751-f8cf991f2c18",
        "created_at": "2016-04-22T19:33:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-33.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "48b4caea-8f65-441e-82f4-e371451d4f2d",
        "url": "/v2/shared_domains/48b4caea-8f65-441e-82f4-e371451d4f2d",
        "created_at": "2016-04-22T19:33:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-34.example.com",
        "router_group_guid": null,
        "router_group_type": null
      }
    },
    {
      "metadata": {
        "guid": "a62f0983-c65b-4e00-b741-f451cafe173d",
        "url": "/v2/shared_domains/a62f0983-c65b-4e00-b741-f451cafe173d",
        "created_at": "2016-04-22T19:33:17Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-35.example.com",
        "router_group_guid": "my-random-guid",
        "router_group_type": "tcp"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 181648e3-5d21-4dd8-a888-6f314b5ba01d
Content-Length: 2410
X-Content-Type-Options: nosniff