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

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3NSIsImVtYWlsIjoiZW1haWwtMzQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTR9.eORVuTn9pcP2KoUEqyU4Cs421mg3po78jZiC7sx6v3c
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/shared_domains" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ3NSIsImVtYWlsIjoiZW1haWwtMzQzQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTg4NTU2OTR9.eORVuTn9pcP2KoUEqyU4Cs421mg3po78jZiC7sx6v3c" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 6,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "9be18417-18ab-4a5d-94c0-fdda0b12f571",
        "url": "/v2/shared_domains/9be18417-18ab-4a5d-94c0-fdda0b12f571",
        "created_at": "2016-03-17T21:41:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain1.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "9d778f6d-1f27-4ba3-a127-c39a00388d42",
        "url": "/v2/shared_domains/9d778f6d-1f27-4ba3-a127-c39a00388d42",
        "created_at": "2016-03-17T21:41:31Z",
        "updated_at": null
      },
      "entity": {
        "name": "customer-app-domain2.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "f27ca7be-3a59-4f28-a5f4-f4d13ee28606",
        "url": "/v2/shared_domains/f27ca7be-3a59-4f28-a5f4-f4d13ee28606",
        "created_at": "2016-03-17T21:41:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-76.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "b79e101c-c26f-43db-8199-23233fa50994",
        "url": "/v2/shared_domains/b79e101c-c26f-43db-8199-23233fa50994",
        "created_at": "2016-03-17T21:41:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-77.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "a1ef3772-cf06-4bd1-b31f-43de19af0949",
        "url": "/v2/shared_domains/a1ef3772-cf06-4bd1-b31f-43de19af0949",
        "created_at": "2016-03-17T21:41:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-78.example.com",
        "router_group_guid": null
      }
    },
    {
      "metadata": {
        "guid": "5699daa2-88d2-4387-9204-e5dea9656873",
        "url": "/v2/shared_domains/5699daa2-88d2-4387-9204-e5dea9656873",
        "created_at": "2016-03-17T21:41:34Z",
        "updated_at": null
      },
      "entity": {
        "name": "domain-79.example.com",
        "router_group_guid": "my-random-guid",
        "router_group_types": [
          "tcp"
        ]
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2258
X-Content-Type-Options: nosniff