Skip to main content

Returns a specific application​

Returns a specific application

Path Parameters
    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the application you wish to retrieve

Responses​

Contains the application definition

Schema
    apiVersion string
    kind string
    metadata

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    labels object

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    apiVersion string
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    apiVersion string
    blockOwnerDeletion boolean
    controller boolean
    kind string
    name string
    uid string
    resourceVersion string
    selfLink string
    uid string
    spec

    ApplicationSpec defines the specification of the app

    cloud string
    components undefined[]

    Components are the definition of the components that make up this application. These are optional, but if specified, Wayfinder can generate example manifests for your application with the components wired together.

    cloudResource

    CloudResource defines the settings for a cloud resource component, required if Type is CloudResource

    plan string
    variables object
    container

    Container defines the settings for a container component, required if Type is Container

    env undefined[]

    Env is a set of environment variables to expose in this container

    fromCloudResourceOutput

    FromCloudResourceOutput gets the value from a dependent cloud resource component's outputs

    componentName string
    output string
    name string
    value string
    expose boolean
    image string
    port int32
    tls boolean
    whitelist string[]
    dependsOn string[]
    key string
    name string
    type string
    description string
    key string
    name string
    status

    ApplicationStatus defines the status of an application

    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    detail string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    obsoleteResources undefined[]
    kind string
    name string
    status string
    wayfinderVersion string
curl -L -X GET 'https://<WAYFINDER-API-ENDPOINT>/api/v1alpha1/workspaces/:workspace/applications/:name' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://<WAYFINDER-API-ENDPOINT>
Auth
Parameters
— pathrequired
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!

Last updated on 28 Dec 2023