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.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MyIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTJ9.SaSREdCnniwH_0fvYxlSDGq90x3b-LKtMhYWcS2InQU
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI0MyIsImVtYWlsIjoiZW1haWwtMTg5QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzI3NzQ5OTJ9.SaSREdCnniwH_0fvYxlSDGq90x3b-LKtMhYWcS2InQU" \
	-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": "3e8ca2ca-04cd-4de0-b001-15cb8a4c4984",
        "url": "/v2/shared_domains/3e8ca2ca-04cd-4de0-b001-15cb8a4c4984",
        "created_at": "2015-05-21T01:03:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com"
      }
    },
    {
      "metadata": {
        "guid": "165929c0-f477-43b6-ac4e-e9b99ffb4c14",
        "url": "/v2/shared_domains/165929c0-f477-43b6-ac4e-e9b99ffb4c14",
        "created_at": "2015-05-21T01:03:00Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com"
      }
    },
    {
      "metadata": {
        "guid": "7dea3a2a-019d-450b-a881-68cd35799255",
        "url": "/v2/shared_domains/7dea3a2a-019d-450b-a881-68cd35799255",
        "created_at": "2015-05-21T01:03:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-51.example.com"
      }
    },
    {
      "metadata": {
        "guid": "1320a9af-62fc-4aeb-9f63-cc50d8ad5664",
        "url": "/v2/shared_domains/1320a9af-62fc-4aeb-9f63-cc50d8ad5664",
        "created_at": "2015-05-21T01:03:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-52.example.com"
      }
    },
    {
      "metadata": {
        "guid": "ceb5028c-0d2c-4d14-aae6-ed78cc350bb0",
        "url": "/v2/shared_domains/ceb5028c-0d2c-4d14-aae6-ed78cc350bb0",
        "created_at": "2015-05-21T01:03:12Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-53.example.com"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7fb56909-93b6-4df5-953f-a43d534b300f
Content-Length: 1666
X-Content-Type-Options: nosniff