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.eyJ1c2VyX2lkIjoidWFhLWlkLTEiLCJlbWFpbCI6ImVtYWlsLTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2MH0.hYmdrcla1z3mlXOx1myTBLIMHpmg7921zgT-Rm3dGfA
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.eyJ1c2VyX2lkIjoidWFhLWlkLTEiLCJlbWFpbCI6ImVtYWlsLTFAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQxOTk4OTk2MH0.hYmdrcla1z3mlXOx1myTBLIMHpmg7921zgT-Rm3dGfA" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 718d0b2d-dc56-44ca-b8e0-e477105e2534
Content-Length: 1688
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1fe34a07-08b6-4c40-992f-c5be55aec931",
        "url": "/v2/shared_domains/1fe34a07-08b6-4c40-992f-c5be55aec931",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "d68c1534-fd76-4c83-94e4-b298ff0d5379",
        "url": "/v2/shared_domains/d68c1534-fd76-4c83-94e4-b298ff0d5379",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "ca2d5581-770c-4336-b189-d2dac015e594",
        "url": "/v2/shared_domains/ca2d5581-770c-4336-b189-d2dac015e594",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-1.example.com"
      }
    },
    {
      "metadata": {
        "guid": "c9d4b4aa-fa57-4ec0-9aad-04f2f7655ee1",
        "url": "/v2/shared_domains/c9d4b4aa-fa57-4ec0-9aad-04f2f7655ee1",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-2.example.com"
      }
    },
    {
      "metadata": {
        "guid": "5ed9c922-bd69-4cc8-89ab-c5ae3878e206",
        "url": "/v2/shared_domains/5ed9c922-bd69-4cc8-89ab-c5ae3878e206",
        "created_at": "2014-12-24T01:39:20+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-3.example.com"
      }
    }
  ]
}