app.container_ids
=================

Returns container IDs for `app_name`.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: app_name</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>app_name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the application to get container IDs for.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    <h5>Parameter 2: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {"alive_only": true}</span><br/>
    <span class="description"><p>Options for filtering the returned container list.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_alive_only">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_alive_only">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_alive_only" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_alive_only" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_alive_only')" type="button"><span class="property-name">alive_only</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_alive_only" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_alive_only" id="Call_parameters_items_i1_alive_only">
    <div class="card-body pl-5">
    <h4>Alive Only</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether to return only running/active containers (<code>true</code>) or include all containers (<code>false</code>).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>AppContainerResponse</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Object containing container ID to details mappings.</p>
    </span>
    <div class="accordion" id="accordionReturn_value_additionalProperties">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties" id="Return_value_additionalProperties">
    <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p>
    <h4>ContainerDetails</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_additionalProperties_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_id" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_id" id="Return_value_additionalProperties_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for the container.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_service_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_service_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_service_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_service_name" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_service_name')" type="button"><span class="property-name">service_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_service_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_service_name" id="Return_value_additionalProperties_service_name">
    <div class="card-body pl-5">
    <h4>Service Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the service this container provides.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_service_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_image">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_image">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_image" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_image" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_image')" type="button"><span class="property-name">image</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_image" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_image" id="Return_value_additionalProperties_image">
    <div class="card-body pl-5">
    <h4>Image</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Docker image name and tag used by this container.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_image_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_state">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_state">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_state" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_state" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_state')" type="button"><span class="property-name">state</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_state" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_state" id="Return_value_additionalProperties_state">
    <div class="card-body pl-5">
    <h4>State</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Current state of the container.</p>
    </span><div class="enum-value" id="Return_value_additionalProperties_state_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"crashed"</li><li class="list-group-item enum-item">"created"</li><li class="list-group-item enum-item">"exited"</li><li class="list-group-item enum-item">"running"</li><li class="list-group-item enum-item">"starting"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* APPS_READ