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.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtNjlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0._MjfZuOK9p5wgA-M8Nk8mPotZyokokALBLMgcWofTIk
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEyMyIsImVtYWlsIjoiZW1haWwtNjlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0MTY2MjU5OH0._MjfZuOK9p5wgA-M8Nk8mPotZyokokALBLMgcWofTIk" \
	-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": "767022a4-9669-4bce-ad4d-5e68061b03f4",
        "url": "/v2/shared_domains/767022a4-9669-4bce-ad4d-5e68061b03f4",
        "created_at": "2015-08-31T21:49:52Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "add7189e-c123-4fcf-96fd-844bfde51081",
        "url": "/v2/shared_domains/add7189e-c123-4fcf-96fd-844bfde51081",
        "created_at": "2015-08-31T21:49:52Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "e143c974-af72-4896-8d76-2e7d1de0acfa",
        "url": "/v2/shared_domains/e143c974-af72-4896-8d76-2e7d1de0acfa",
        "created_at": "2015-08-31T21:49:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-22.example.com"
      }
    },
    {
      "metadata": {
        "guid": "539e9c17-99b6-4021-8eb5-96c8eac6a263",
        "url": "/v2/shared_domains/539e9c17-99b6-4021-8eb5-96c8eac6a263",
        "created_at": "2015-08-31T21:49:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-23.example.com"
      }
    },
    {
      "metadata": {
        "guid": "adc96a77-e166-4092-ad8e-eb75ae454e4d",
        "url": "/v2/shared_domains/adc96a77-e166-4092-ad8e-eb75ae454e4d",
        "created_at": "2015-08-31T21:49:58Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-24.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5e41d292-7390-4e4a-9d77-c4b12406a94a
Content-Length: 1666
X-Content-Type-Options: nosniff