Skip to main content

Retrieves a list of application deployments filter summary Supported filter fields - ['appDeploymentName', 'clusterUid', 'tags'] Supported sort fields - ['appDeploymentName', 'creationTimestamp', 'lastModifiedTimestamp']

POST 
/v1/dashboard/appDeployments

Retrieves a list of application deployments filter summary Supported filter fields - ["appDeploymentName", "clusterUid", "tags"] Supported sort fields - ["appDeploymentName", "creationTimestamp", "lastModifiedTimestamp"]

Request​

Query Parameters

    limit int64

    Possible values: <= 20

    limit is a maximum number of responses to return for a list call. Maximum value of the limit is 20. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

    offset int64

    offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

    continue string

    continue token to paginate the subsequent data items

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    filter

    Application deployment filter spec

    appDeploymentName

    object

    beginsWithstringnullable
    containsstringnullable
    eqstringnullable
    ignoreCaseboolean

    Default value: true

    nestringnullable

    clusterUids

    object

    beginsWithstring[]nullable
    eqstring[]nullable
    ignoreCaseboolean

    Default value: true

    nestring[]nullable

    tags

    object

    beginsWithstring[]nullable
    eqstring[]nullable
    ignoreCaseboolean

    Default value: true

    nestring[]nullable

    sort

    undefined[]

  • Array [

    • fieldstringnullable

    Possible values: [appDeploymentName, creationTimestamp, lastModifiedTimestamp]

    orderstring

    Possible values: [asc, desc]

    Default value: asc

  • ]

Responses​

An array of application deployment summary items

Schema

    appDeployments

    object[]

  • Array [

    • metadata

    object

    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
    creationTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    deletionTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    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
    lastModifiedTimestampdate-time

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

    namestring

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

    uidstring

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

    spec

    object

    Application deployment spec summary

    config

    Application deployment config summary

    target

    Application deployment target config summary

    clusterRef

    Application deployment cluster reference

    deploymentClusterTypestring

    Possible values: [virtual, host]

    Application deployment source cluster type[ "virtualCluster", "hostCluster" ]

    namestring

    Application deployment source cluster name

    uidstring

    Application deployment source cluster uid

    profile

    Application deployment profile summary

    metadata

    Application deployment profile metadata summary

    namestring
    uidstring
    versionstring

    template

    object

    Application profile template summary

    appTiers

    undefined[]

  • Array [

    • namestring

    source

    Application profile's tier source information

    addonSubTypestring
    addonTypestring
    logoUrlstring
    namestring
    typestring
    uidstring
    typestring
    uidstring
    versionstring

  • ]

    • status

    object

    Application deployment status summary

    cluster

    Application deployment cluster status

    health

    Application deployment cluster health status

    statestring
    statestring

    notifications

    Application deployment notifications

    isAvailableboolean
    statestring

  • ]

    • listmeta

    object

    ListMeta describes metadata for the resource listing

    continuestring

    Next token for the pagination. Next token is equal to empty string indicates end of result set.

    countinteger

    Total count of the resources which might change during pagination based on the resources addition or deletion

    limitinteger

    Number of records feteched

    offsetinteger

    The next offset for the pagination. Starting index for which next request will be placed.

Loading...