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

Body

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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ2NiIsImVtYWlsIjoiZW1haWwtMzM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODh9.Ew4BnzmXz8cDXHGDB-UjoO1hKovsOXDq-9rfwWmjjo4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ2NiIsImVtYWlsIjoiZW1haWwtMzM3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTM4MzcyODh9.Ew4BnzmXz8cDXHGDB-UjoO1hKovsOXDq-9rfwWmjjo4" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "42aa6954-42b5-4de9-8b26-34ac83a92165",
        "url": "/v2/shared_domains/42aa6954-42b5-4de9-8b26-34ac83a92165",
        "created_at": "2016-01-19T19:41:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "f2bc4923-06e6-4873-9a0a-18aca2d3f104",
        "url": "/v2/shared_domains/f2bc4923-06e6-4873-9a0a-18aca2d3f104",
        "created_at": "2016-01-19T19:41:01Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "d80421a0-bfe3-440e-adb3-074b8ed3f09d",
        "url": "/v2/shared_domains/d80421a0-bfe3-440e-adb3-074b8ed3f09d",
        "created_at": "2016-01-19T19:41:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-71.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "1078f6a0-4f8d-4a97-8401-e0a4e0897fe9",
        "url": "/v2/shared_domains/1078f6a0-4f8d-4a97-8401-e0a4e0897fe9",
        "created_at": "2016-01-19T19:41:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-72.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "b8dd28c5-4b89-4e17-ae17-547f50947f1c",
        "url": "/v2/shared_domains/b8dd28c5-4b89-4e17-ae17-547f50947f1c",
        "created_at": "2016-01-19T19:41:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-73.example.com",
        "router_group_guid": null
      }
    }
  ]
}

Headers

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