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.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNSIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MDZ9.5td2hJeXcJ2PSPxGjG4QHVl9bOy-VD__346qis2el7Q
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTIxNSIsImVtYWlsIjoiZW1haWwtMTQ2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjkwMzg3MDZ9.5td2hJeXcJ2PSPxGjG4QHVl9bOy-VD__346qis2el7Q" \
	-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": "79489e1f-f804-42ba-8596-5980fa779f10",
        "url": "/v2/shared_domains/79489e1f-f804-42ba-8596-5980fa779f10",
        "created_at": "2015-04-07T19:11:38Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "1be99d40-5f66-4b0e-9eb5-c3023585de76",
        "url": "/v2/shared_domains/1be99d40-5f66-4b0e-9eb5-c3023585de76",
        "created_at": "2015-04-07T19:11:38Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "27f9519b-689f-4b44-b756-d1c1c1825dff",
        "url": "/v2/shared_domains/27f9519b-689f-4b44-b756-d1c1c1825dff",
        "created_at": "2015-04-07T19:11:46Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-25.example.com"
      }
    },
    {
      "metadata": {
        "guid": "0f381b3d-b635-476d-8acf-d92c1a15d459",
        "url": "/v2/shared_domains/0f381b3d-b635-476d-8acf-d92c1a15d459",
        "created_at": "2015-04-07T19:11:46Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-26.example.com"
      }
    },
    {
      "metadata": {
        "guid": "a680c29a-3602-47a9-95c8-c665c05bc1ca",
        "url": "/v2/shared_domains/a680c29a-3602-47a9-95c8-c665c05bc1ca",
        "created_at": "2015-04-07T19:11:46Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-27.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: f58f92ac-de7b-43f2-a098-95a0ebf86e9f
Content-Length: 1666
X-Content-Type-Options: nosniff