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.eyJ1c2VyX2lkIjoidWFhLWlkLTExNiIsImVtYWlsIjoiZW1haWwtODZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.cx10qJexZ62C3kO7hFT4vvh9ypPoaGDfMV_q6u0qQ7k
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.eyJ1c2VyX2lkIjoidWFhLWlkLTExNiIsImVtYWlsIjoiZW1haWwtODZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyMjk5MDg3MX0.cx10qJexZ62C3kO7hFT4vvh9ypPoaGDfMV_q6u0qQ7k" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: e7c1f24b-d638-400c-99ed-33f06732d04c
Content-Length: 1666
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 5,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "ccf9fe3a-f953-4c4e-977b-98a5282311e5",
        "url": "/v2/shared_domains/ccf9fe3a-f953-4c4e-977b-98a5282311e5",
        "created_at": "2015-01-27T19:14:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "105da5ad-e7c7-401d-851c-ad4aa7f002f6",
        "url": "/v2/shared_domains/105da5ad-e7c7-401d-851c-ad4aa7f002f6",
        "created_at": "2015-01-27T19:14:28Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "f0678235-c3c7-49c1-9be6-43a777fd0c5d",
        "url": "/v2/shared_domains/f0678235-c3c7-49c1-9be6-43a777fd0c5d",
        "created_at": "2015-01-27T19:14:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-39.example.com"
      }
    },
    {
      "metadata": {
        "guid": "ec2a6a21-44df-416a-83ca-e7e47e0df1a1",
        "url": "/v2/shared_domains/ec2a6a21-44df-416a-83ca-e7e47e0df1a1",
        "created_at": "2015-01-27T19:14:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-40.example.com"
      }
    },
    {
      "metadata": {
        "guid": "f0c2a329-91ec-4be4-b9a5-a923328c0c49",
        "url": "/v2/shared_domains/f0c2a329-91ec-4be4-b9a5-a923328c0c49",
        "created_at": "2015-01-27T19:14:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-41.example.com"
      }
    }
  ]
}