cloudfoundry/cloud_controller_ng

View on GitHub
docs/v2/apps/list_all_apps.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>List all Apps</h2>
    <h3>GET /v2/apps</h3>

      <h3>Request</h3>
      <h4>Route</h4>
      <pre class="request route highlight">GET /v2/apps</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">q</span>
              </td>
              <td>
                  <span class="description">Parameters used to filter the result set.<br/>Format queries as &lt;filter&gt;&lt;op&gt;&lt;value&gt;<br/> Valid ops: : &gt;= &lt;= &lt; &gt; IN<br/> Valid filters: name, space_guid, organization_guid, diego, stack_guid</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                    <li>q=filter:value</li>
                    <li>q=filter&gt;value</li>
                    <li>q=filter IN a,b,c</li>
                </ul>
              </td>
            </tr>
            <tr class="">
              <td class=" ">
                  <span class="name">page</span>
              </td>
              <td>
                  <span class="description">Page of results to fetch</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="">
              <td class=" ">
                  <span class="name">results-per-page</span>
              </td>
              <td>
                  <span class="description">Number of results per page</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="">
              <td class=" ">
                  <span class="name">order-direction</span>
              </td>
              <td>
                  <span class="description">Order of the results: asc (default) or desc</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="deprecated">
              <td class=" ">
                  <span class="name">inline-relations-depth</span>
              </td>
              <td>
                  <span class="description">0 - don&#39;t inline any relations and return URLs.  Otherwise, inline to depth N.</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="deprecated">
              <td class=" ">
                  <span class="name">orphan-relations</span>
              </td>
              <td>
                  <span class="description">0 - de-duplicate object entries in response</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="deprecated">
              <td class=" ">
                  <span class="name">exclude-relations</span>
              </td>
              <td>
                  <span class="description">comma-delimited list of relations to drop from response</span>
              </td>
              <td>
                <ul class="valid_values">
                </ul>
              </td>
              <td>
                <ul class="example_values">
                </ul>
              </td>
            </tr>
            <tr class="deprecated">
              <td class=" ">
                  <span class="name">include-relations</span>
              </td>
              <td>
                  <span class="description">comma-delimited list of the only relations to include in response</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.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDV9.aDT-ydnSwmSIdukBXVx9CB9ktBfnAHh9t2JKsudB8-0
Host: example.org
Cookie: </pre>

        <h4>cURL</h4>
        <pre class="request curl">curl &quot;https://api.[your-domain.com]/v2/apps&quot; -X GET \
    -H &quot;Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTQ0MyIsImVtYWlsIjoiZW1haWwtMzA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg5MDV9.aDT-ydnSwmSIdukBXVx9CB9ktBfnAHh9t2JKsudB8-0&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>
          <table class="response-fields 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>
                    <span class="name">name</span>
                </td>
                <td>
                  <span class="description">The name of the app.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>my_super_app</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">memory</span>
                </td>
                <td>
                  <span class="description">The amount of memory each instance should have. In megabytes.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>1024</li>
                        <li>512</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">instances</span>
                </td>
                <td>
                  <span class="description">The number of instances of the app to run. To ensure optimal availability, ensure there are at least 2 instances.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>2</li>
                        <li>6</li>
                        <li>10</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">disk_quota</span>
                </td>
                <td>
                  <span class="description">The maximum amount of disk available to an instance of an app. In megabytes.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>1204</li>
                        <li>2048</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">space_guid</span>
                </td>
                <td>
                  <span class="description">The guid of the associated space.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>guid-a7130f7d-23ae-41db-97ae-f6f4bbf99a11</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">stack_guid</span>
                </td>
                <td>
                  <span class="description">The guid of the associated stack.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>guid-3b1c8f42-9e13-46e6-a7a1-1f606c090c39</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">state</span>
                </td>
                <td>
                  <span class="description">The current desired state of the app. One of STOPPED or STARTED.</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>STOPPED</li>
                      <li>STARTED</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">command</span>
                </td>
                <td>
                  <span class="description">The command to start an app after it is staged, maximum length: 4096 (e.g. &#39;rails s -p $PORT&#39; or &#39;java com.org.Server $PORT&#39;).</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">buildpack</span>
                </td>
                <td>
                  <span class="description">Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li></li>
                        <li>https://github.com/virtualstaticvoid/heroku-buildpack-r.git</li>
                        <li>an_example_installed_buildpack</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                  <span class="name">detected_buildpack</span>
                </td>
                <td>
                  <span class="description">Buildpack that has been found for the app through autodetection</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                    <li></li>
                    <li>ruby 1.6.20</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                  <span class="name">detected_buildpack_guid</span>
                </td>
                <td>
                  <span class="description">Guid of the detected_buildpack</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                    <li></li>
                    <li>d12fdf1a-f061-4040-81f4-b5b5b55570bd</li>
                  </ul>
                </td>
              </tr>
              <tr class=" ">
                <td class=" ">
                  <span class="name">health_check_http_endpoint</span>
                </td>
                <td>
                  <span class="description">Endpoint called to determine if the app is healthy.</span>
                </td>
                <td>
                  <span class="valid_values"></span>
                </td>
                <td>
                  <ul class="example_values">
                    <li>/health</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">health_check_type</span>
                </td>
                <td>
                  <span class="description">Type of health check to perform. &#39;none&#39; is deprecated and an alias to &#39;process&#39;.</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>http</li>
                      <li>port</li>
                      <li>process</li>
                      <li>none</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">health_check_timeout</span>
                </td>
                <td>
                    <span class="description">Timeout in seconds for health checking of an staged app when starting up</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">diego</span>
                </td>
                <td>
                  <span class="description">Use diego to stage and to run when available</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>true</li>
                      <li>false</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">enable_ssh</span>
                </td>
                <td>
                  <span class="description">Enable SSHing into the app. Supported for Diego only.</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>true</li>
                      <li>false</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">detected_start_command</span>
                </td>
                <td>
                  <span class="description">The command detected by the buildpack during staging.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>rails s</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">docker_image</span>
                </td>
                <td>
                  <span class="description">Name of the Docker image containing the app. The &quot;diego_docker&quot; feature flag must be enabled in order to create Docker image apps.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>cloudfoundry/diego-docker-app</li>
                        <li>registry.example.com:5000/user/repository/tag</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">docker_credentials</span>
                </td>
                <td>
                  <span class="description">Docker credentials for pulling docker image.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>{"username": "user", "password": "***"}</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">environment_json</span>
                </td>
                <td>
                  <span class="description">Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="deprecated">
                <td>
                    <span class="name">production</span>
                </td>
                <td>
                  <span class="description">Deprecated.</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>true</li>
                      <li>false</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="deprecated">
                <td>
                    <span class="name">console</span>
                </td>
                <td>
                  <span class="description">Open the console port for the app (at $CONSOLE_PORT).</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>true</li>
                      <li>false</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="deprecated">
                <td>
                    <span class="name">debug</span>
                </td>
                <td>
                  <span class="description">Open the debug port for the app (at $DEBUG_PORT).</span>
                </td>
                <td>
                  <ul class="valid_values">
                      <li>true</li>
                      <li>false</li>
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">staging_failed_reason</span>
                </td>
                <td>
                  <span class="description">Reason for application staging failures</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>StagingError</li>
                        <li>StagingTimeExpired</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">staging_failed_description</span>
                </td>
                <td>
                  <span class="description">Detailed description for the staging_failed_reason</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>An app was not successfully detected by any available buildpack</li>
                  </ul>
                </td>
              </tr>
              <tr class="">
                <td>
                    <span class="name">ports</span>
                </td>
                <td>
                  <span class="description">Ports on which application may listen. Overwrites previously configured ports. Ports must be in range 1024-65535. Supported for Diego only.</span>
                </td>
                <td>
                  <ul class="valid_values">
                  </ul>
                </td>
                <td>
                  <ul class="example_values">
                        <li>[5222, 8080]</li>
                        <li>[1056]</li>
                  </ul>
                </td>
              </tr>
            </tbody>
          </table>

          <pre class="response body">{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "6064d98a-95e6-400b-bc03-be65e6d59622",
        "url": "/v2/apps/6064d98a-95e6-400b-bc03-be65e6d59622",
        "created_at": "2016-06-08T16:41:45Z",
        "updated_at": "2016-06-08T16:41:45Z"
      },
      "entity": {
        "name": "name-2443",
        "production": false,
        "space_guid": "9c5c8a91-a728-4608-9f5e-6c8026c3a2ac",
        "stack_guid": "f6c960cc-98ba-4fd1-b197-ecbf39108aa2",
        "buildpack": null,
        "detected_buildpack": null,
        "detected_buildpack_guid": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "f5696e0f-087d-49b0-9ad7-4756c49a6ba6",
        "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:45Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "ports": null,
        "space_url": "/v2/spaces/9c5c8a91-a728-4608-9f5e-6c8026c3a2ac",
        "stack_url": "/v2/stacks/f6c960cc-98ba-4fd1-b197-ecbf39108aa2",
        "routes_url": "/v2/apps/6064d98a-95e6-400b-bc03-be65e6d59622/routes",
        "events_url": "/v2/apps/6064d98a-95e6-400b-bc03-be65e6d59622/events",
        "service_bindings_url": "/v2/apps/6064d98a-95e6-400b-bc03-be65e6d59622/service_bindings",
        "route_mappings_url": "/v2/apps/6064d98a-95e6-400b-bc03-be65e6d59622/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "69ebed50-222a-4880-b163-fb1bf7d60b0c",
        "url": "/v2/apps/69ebed50-222a-4880-b163-fb1bf7d60b0c",
        "created_at": "2016-06-08T16:41:45Z",
        "updated_at": "2016-06-08T16:41:45Z"
      },
      "entity": {
        "name": "name-2437",
        "production": false,
        "space_guid": "5a98cff5-d97b-4828-9bfe-8d3f9fc80d3a",
        "stack_guid": "5dc6e2cc-9f50-4c8f-9a11-1a7f821e3d09",
        "buildpack": null,
        "detected_buildpack": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "cf98a13f-4001-4595-ba34-a9a7f32b2fb2",
        "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:45Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "ports": null,
        "space_url": "/v2/spaces/5a98cff5-d97b-4828-9bfe-8d3f9fc80d3a",
        "stack_url": "/v2/stacks/5dc6e2cc-9f50-4c8f-9a11-1a7f821e3d09",
        "routes_url": "/v2/apps/69ebed50-222a-4880-b163-fb1bf7d60b0c/routes",
        "events_url": "/v2/apps/69ebed50-222a-4880-b163-fb1bf7d60b0c/events",
        "service_bindings_url": "/v2/apps/69ebed50-222a-4880-b163-fb1bf7d60b0c/service_bindings",
        "route_mappings_url": "/v2/apps/69ebed50-222a-4880-b163-fb1bf7d60b0c/route_mappings"
      }
    },
    {
      "metadata": {
        "guid": "d7133689-3df2-4907-b335-3621cbb21507",
        "url": "/v2/apps/d7133689-3df2-4907-b335-3621cbb21507",
        "created_at": "2016-06-08T16:41:45Z",
        "updated_at": "2016-06-08T16:41:45Z"
      },
      "entity": {
        "name": "name-2431",
        "production": false,
        "space_guid": "004c5060-b2df-48bc-8388-1f129be2e232",
        "stack_guid": "3e462631-6d79-4f1a-8538-c8f1c7b50fc9",
        "buildpack": null,
        "detected_buildpack": null,
        "detected_buildpack_guid": null,
        "environment_json": null,
        "memory": 1024,
        "instances": 1,
        "disk_quota": 1024,
        "state": "STOPPED",
        "version": "120d2490-f8c6-4e7d-86ed-be6f54ed6eb3",
        "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:45Z",
        "detected_start_command": "",
        "enable_ssh": true,
        "ports": null,
        "space_url": "/v2/spaces/004c5060-b2df-48bc-8388-1f129be2e232",
        "stack_url": "/v2/stacks/3e462631-6d79-4f1a-8538-c8f1c7b50fc9",
        "routes_url": "/v2/apps/d7133689-3df2-4907-b335-3621cbb21507/routes",
        "events_url": "/v2/apps/d7133689-3df2-4907-b335-3621cbb21507/events",
        "service_bindings_url": "/v2/apps/d7133689-3df2-4907-b335-3621cbb21507/service_bindings",
        "route_mappings_url": "/v2/apps/d7133689-3df2-4907-b335-3621cbb21507/route_mappings"
      }
    }
  ]
}</pre>

        <h4>Headers</h4>
        <pre class="response headers">Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: dd5a71fd-4b2b-449f-90aa-75380eb13b7e
Content-Length: 5541
X-Content-Type-Options: nosniff</pre>

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