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.
name The name of the domain.
  • example.com
  • foo.example.com

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNyIsImVtYWlsIjoiZW1haWwtOTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzODY0MTc5M30.JqpCGmxjTP-f3SBKbhge2lB8Hh6moO6vRsyZolUYQg4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNyIsImVtYWlsIjoiZW1haWwtOTJAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzODY0MTc5M30.JqpCGmxjTP-f3SBKbhge2lB8Hh6moO6vRsyZolUYQg4" \
	-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": "08ac844a-e880-48ef-a90c-f95131582fcc",
        "url": "/v2/shared_domains/08ac844a-e880-48ef-a90c-f95131582fcc",
        "created_at": "2015-07-27T22:43:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "973dcea1-5011-4bd0-aa9e-fa232bfaada7",
        "url": "/v2/shared_domains/973dcea1-5011-4bd0-aa9e-fa232bfaada7",
        "created_at": "2015-07-27T22:43:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "95dd4fc9-91c1-43f8-8e5e-7c7819cb5342",
        "url": "/v2/shared_domains/95dd4fc9-91c1-43f8-8e5e-7c7819cb5342",
        "created_at": "2015-07-27T22:43:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-36.example.com"
      }
    },
    {
      "metadata": {
        "guid": "6b4afebe-587d-47ad-ad18-be42f1380785",
        "url": "/v2/shared_domains/6b4afebe-587d-47ad-ad18-be42f1380785",
        "created_at": "2015-07-27T22:43:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-37.example.com"
      }
    },
    {
      "metadata": {
        "guid": "32fdabc8-2d08-4a2c-bc6b-e96174d095b6",
        "url": "/v2/shared_domains/32fdabc8-2d08-4a2c-bc6b-e96174d095b6",
        "created_at": "2015-07-27T22:43:13Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-38.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 231f7cfe-9049-471e-93d2-795d5098541a
Content-Length: 1666
X-Content-Type-Options: nosniff