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.eyJ1c2VyX2lkIjoidWFhLWlkLTU1IiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.vs0w7PUw3JmQrqoyez7q3-8wVCkEEwoM9MJA_3R_Xws
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.eyJ1c2VyX2lkIjoidWFhLWlkLTU1IiwiZW1haWwiOiJlbWFpbC00OEBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDE2NTI2Njk4fQ.vs0w7PUw3JmQrqoyez7q3-8wVCkEEwoM9MJA_3R_Xws" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7cedd1be-eb5e-4843-bade-2c47b24b4ff1
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": "10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9",
        "url": "/v2/shared_domains/10e72d9a-9f21-4fdc-a17e-7a3c8f5dcdf9",
        "created_at": "2014-11-13T23:38:13+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "2a42f853-463e-4a7c-80fd-1a3c394a54c7",
        "url": "/v2/shared_domains/2a42f853-463e-4a7c-80fd-1a3c394a54c7",
        "created_at": "2014-11-13T23:38:13+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "93ea3d66-0d79-4cb0-9781-a428ea7100ba",
        "url": "/v2/shared_domains/93ea3d66-0d79-4cb0-9781-a428ea7100ba",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-12.example.com"
      }
    },
    {
      "metadata": {
        "guid": "880e1e4a-fc2d-4346-8cd8-32f4e72daa1b",
        "url": "/v2/shared_domains/880e1e4a-fc2d-4346-8cd8-32f4e72daa1b",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-13.example.com"
      }
    },
    {
      "metadata": {
        "guid": "196bd722-3123-487b-82a2-9c2db0063cf0",
        "url": "/v2/shared_domains/196bd722-3123-487b-82a2-9c2db0063cf0",
        "created_at": "2014-11-13T23:38:18+00:00",
        "updated_at": null
      },
      "entity": {
        "name": "domain-14.example.com"
      }
    }
  ]
}