cloudfoundry/cloud_controller_ng

View on GitHub
docs/v2/feature_flags/get_the_private_domain_creation_feature_flag.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
  <title>Feature Flags API</title>
  <meta charset="utf-8">
  <link id="bootstrapcss" rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" />
  <script>
    if( "file:" == document.location.protocol ) {
      var csslink = document.getElementById("bootstrapcss");
      csslink.href = "http://" + csslink.href.replace(/.*\/\//, "");
    }
  </script>
  <style>
    p {
      padding: 15px;
      font-size: 130%;
    }

    pre {
      white-space: pre;
    }

    td.required .name:after {
      float: right;
      content: " required";
      font-weight: normal;
      color: #F08080;
    }

    td.experimental:after {
      float: right;
      content: " experimental";
      font-weight: normal;
      color: #FFA500;
      padding: 2px;
    }

    tr.deprecated td:first-child:before {
      content: "deprecated: ";
      font-weight: bold;
      color: gray;
    }

    tr.deprecated span, tr.deprecated ul {
      text-decoration: line-through;
      color: gray;
    }

    tr.readonly .name:after {
      float: right;
      content: " read-only";
      font-weight: normal;
    }

    tr.readonly {
      color: grey;
    }

    table ul {
      padding-left: 1.2em;
    }
  </style>
</head>
<body>
<div class="container">
  <h1>Feature Flags API</h1>

  <div class="article">
    <h2>Get the Private Domain Creation feature flag</h2>
    <h3>GET /v2/config/feature_flags/private_domain_creation</h3>
      <p class="explanation">
        When enabled, an organization manager can create private domains for that organization. When disabled, only admin users can create private domains.
      </p>

      <h3>Request</h3>
      <h4>Route</h4>
      <pre class="request route highlight">GET /v2/config/feature_flags/private_domain_creation</pre>





      <h4>Headers</h4>
      <pre class="request headers">Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDB9.3UMm7S4sPCyUVVOm0SlF3s8D331SfUKHBpJvQj_4sy0
Host: example.org
Cookie: </pre>

        <h4>cURL</h4>
        <pre class="request curl">curl &quot;https://api.[your-domain.com]/v2/config/feature_flags/private_domain_creation&quot; -X GET \
    -H &quot;Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjQyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDB9.3UMm7S4sPCyUVVOm0SlF3s8D331SfUKHBpJvQj_4sy0&quot; \
    -H &quot;Host: example.org&quot; \
    -H &quot;Cookie: &quot;</pre>

        <h3>Response</h3>

        <h4>Status</h4>
        <pre class="response status">200 OK</pre>

          <h4>Body</h4>

          <pre class="response body">{
  "name": "private_domain_creation",
  "enabled": true,
  "error_message": null,
  "url": "/v2/config/feature_flags/private_domain_creation"
}</pre>

        <h4>Headers</h4>
        <pre class="response headers">Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: d4f6f698-e8ea-4245-b993-e4c13512490e
Content-Length: 144
X-Content-Type-Options: nosniff</pre>

  </div>
</div>
</body>
</html>