Home
Version 3
Shared Domains API

Shared Domains API

List all Shared Domains

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.
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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI1NyIsImVtYWlsIjoiZW1haWwtMTk3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1NTB9.iALkmQRIIoMsV46GXLChmwZnJaek4rEiHa6Tt7ljmeA
Host: example.org
Cookie: 

Route

GET /v2/shared_domains

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 931cba6d-ab62-472f-95aa-f790f02df828
Content-Length: 1691
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "626ae416-700c-4a54-81a8-961c8d86df24",
        "url": "/v2/shared_domains/626ae416-700c-4a54-81a8-961c8d86df24",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "86159d7d-4806-44c8-99ba-866fdb507f86",
        "url": "/v2/shared_domains/86159d7d-4806-44c8-99ba-866fdb507f86",
        "created_at": "2015-01-20T01:52:15+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "ec0ab703-1b7d-4628-bb80-e2b74ca937a8",
        "url": "/v2/shared_domains/ec0ab703-1b7d-4628-bb80-e2b74ca937a8",
        "created_at": "2015-01-20T01:52:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com"
      }
    },
    {
      "metadata": {
        "guid": "0789c908-e7b5-4604-9455-f88043280f2a",
        "url": "/v2/shared_domains/0789c908-e7b5-4604-9455-f88043280f2a",
        "created_at": "2015-01-20T01:52:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-42.example.com"
      }
    },
    {
      "metadata": {
        "guid": "3bf11d56-5b4a-4c48-b59d-974c718a85e9",
        "url": "/v2/shared_domains/3bf11d56-5b4a-4c48-b59d-974c718a85e9",
        "created_at": "2015-01-20T01:52:30+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-43.example.com"
      }
    }
  ]
}