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.eyJ1c2VyX2lkIjoidWFhLWlkLTMzOCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDV9.bpjjKogTkPT9tpJaKyYzS9s-mLev5P2r_Wv-eAtQs2E
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMzOCIsImVtYWlsIjoiZW1haWwtMjM2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDI2MDE1NDV9.bpjjKogTkPT9tpJaKyYzS9s-mLev5P2r_Wv-eAtQs2E" \
	-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": "9c9d4ae3-f822-4830-9442-ab3f987f763e",
        "url": "/v2/shared_domains/9c9d4ae3-f822-4830-9442-ab3f987f763e",
        "created_at": "2015-09-11T18:38:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "38195989-c846-4c34-93cb-913051b077b9",
        "url": "/v2/shared_domains/38195989-c846-4c34-93cb-913051b077b9",
        "created_at": "2015-09-11T18:38:57Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "b15ddfa8-8d5b-4173-9a6a-f89226143bc4",
        "url": "/v2/shared_domains/b15ddfa8-8d5b-4173-9a6a-f89226143bc4",
        "created_at": "2015-09-11T18:39:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-53.example.com"
      }
    },
    {
      "metadata": {
        "guid": "4f1570a6-80a7-4369-8ae3-569d85951e6a",
        "url": "/v2/shared_domains/4f1570a6-80a7-4369-8ae3-569d85951e6a",
        "created_at": "2015-09-11T18:39:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-54.example.com"
      }
    },
    {
      "metadata": {
        "guid": "1b1497b2-755c-45ff-82a8-905138abc075",
        "url": "/v2/shared_domains/1b1497b2-755c-45ff-82a8-905138abc075",
        "created_at": "2015-09-11T18:39:05Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-55.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 030c98bc-f7a6-4afa-9310-cfa29f4d713a
Content-Length: 1666
X-Content-Type-Options: nosniff