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.eyJ1c2VyX2lkIjoidWFhLWlkLTE5IiwiZW1haWwiOiJlbWFpbC0xOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ1fQ.PHqkjjHVHmftdluqVsPxC8KcQvWwQPQH0ue-YpsvisM
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5IiwiZW1haWwiOiJlbWFpbC0xOUBzb21lZG9tYWluLmNvbSIsInNjb3BlIjpbImNsb3VkX2NvbnRyb2xsZXIuYWRtaW4iXSwiYXVkIjpbImNsb3VkX2NvbnRyb2xsZXIiXSwiZXhwIjoxNDM1MTAyODQ1fQ.PHqkjjHVHmftdluqVsPxC8KcQvWwQPQH0ue-YpsvisM" \
	-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": "886f0391-d28e-46bd-a4c8-28ec9bed6623",
        "url": "/v2/shared_domains/886f0391-d28e-46bd-a4c8-28ec9bed6623",
        "created_at": "2015-06-16T23:40:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "e903e7f7-a570-4d58-8da6-d87a1a16ae37",
        "url": "/v2/shared_domains/e903e7f7-a570-4d58-8da6-d87a1a16ae37",
        "created_at": "2015-06-16T23:40:41Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "0bf83ca9-2367-4400-b5b3-536f89e4eebe",
        "url": "/v2/shared_domains/0bf83ca9-2367-4400-b5b3-536f89e4eebe",
        "created_at": "2015-06-16T23:40:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-13.example.com"
      }
    },
    {
      "metadata": {
        "guid": "b73c99fc-633d-46e8-bc52-e34d423e81a1",
        "url": "/v2/shared_domains/b73c99fc-633d-46e8-bc52-e34d423e81a1",
        "created_at": "2015-06-16T23:40:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-14.example.com"
      }
    },
    {
      "metadata": {
        "guid": "c747b18c-a3d5-4e2c-8ad7-cf5410985348",
        "url": "/v2/shared_domains/c747b18c-a3d5-4e2c-8ad7-cf5410985348",
        "created_at": "2015-06-16T23:40:45Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-15.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 0039df58-faf9-4eeb-96cc-5ee1e2c5c1d5
Content-Length: 1666
X-Content-Type-Options: nosniff