cloudfoundry/cloud_controller_ng

View on GitHub
docs/v2/apps/restage_an_app.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
  <title>Apps 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>Apps API</h1>

  <div class="article">
    <h2>Restage an App</h2>
    <h3>POST /v2/apps/:guid/restage</h3>

      <h3>Request</h3>
      <h4>Route</h4>
      <pre class="request route highlight">POST /v2/apps/83e7e4bf-443e-45ce-8f36-659c46809abb/restage</pre>

        <h4>Parameters</h4>
        <table class="parameters table table-striped table-bordered table-condensed">
          <thead>
          <tr>
            <th>Name</th>
            <th>Description</th>
            <th>Valid Values</th>
            <th>Example Values</th>
          </tr>
          </thead>
          <tbody>
            <tr class="">
              <td class=" ">
                  <span class="name">guid</span>
              </td>
              <td>
                  <span class="description">The guid of the App</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
          </tbody>
        </table>




      <h4>Headers</h4>
      <pre class="request headers">Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjUxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDB9.1Td5LF3_cmexuuKHparnwwxYyHJ53b7BYdmlZyTeOP0
Host: example.org
Content-Type: application/json
Cookie: </pre>

        <h4>cURL</h4>
        <pre class="request curl">curl &quot;https://api.[your-domain.com]/v2/apps/83e7e4bf-443e-45ce-8f36-659c46809abb/restage&quot; -d &#39;&#39; -X POST \
    -H &quot;Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM1NyIsImVtYWlsIjoiZW1haWwtMjUxQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDB9.1Td5LF3_cmexuuKHparnwwxYyHJ53b7BYdmlZyTeOP0&quot; \
    -H &quot;Host: example.org&quot; \
    -H &quot;Content-Type: application/json&quot; \
    -H &quot;Cookie: &quot;</pre>

        <h3>Response</h3>

        <h4>Status</h4>
        <pre class="response status">201 Created</pre>

          <h4>Body</h4>

          <pre class="response body">{
  "metadata": {
    "guid": "83e7e4bf-443e-45ce-8f36-659c46809abb",
    "url": "/v2/apps/83e7e4bf-443e-45ce-8f36-659c46809abb",
    "created_at": "2016-06-08T16:41:40Z",
    "updated_at": "2016-06-08T16:41:40Z"
  },
  "entity": {
    "name": "name-2047",
    "production": false,
    "space_guid": "b1787767-ca42-4fcf-989e-2530fe2987a5",
    "stack_guid": "00caa65b-55f4-4c72-8e61-011c20189462",
    "buildpack": null,
    "detected_buildpack": null,
    "detected_buildpack_guid": null,
    "environment_json": null,
    "memory": 1024,
    "instances": 1,
    "disk_quota": 1024,
    "state": "STARTED",
    "version": "4de62557-7599-422e-93ab-49e6b6ede56b",
    "command": null,
    "console": false,
    "debug": null,
    "staging_task_id": null,
    "package_state": "PENDING",
    "health_check_http_endpoint": "",
    "health_check_type": "port",
    "health_check_timeout": null,
    "staging_failed_reason": null,
    "staging_failed_description": null,
    "diego": false,
    "docker_image": null,
    "docker_credentials": {
      "username": null,
      "password": null
    },
    "package_updated_at": "2016-06-08T16:41:40Z",
    "detected_start_command": "",
    "enable_ssh": true,
    "ports": null
  }
}</pre>

        <h4>Headers</h4>
        <pre class="response headers">Content-Type: application/json;charset=utf-8
Location: /v2/apps/83e7e4bf-443e-45ce-8f36-659c46809abb
X-VCAP-Request-ID: e9d5a598-33d9-4a6c-9e6b-fd36fed23f1f
Content-Length: 1158
X-Content-Type-Options: nosniff</pre>

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