Skip to main content

Retrieves a list of projects

GET 
/v1/projects

Deprecated: Use POST /v1/dashboard/projects

Request​

Query Parameters

    fields string

    Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name

    filters string

    Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws

    Server will be restricted to certain fields based on the indexed data for each resource.

    orderBy string

    Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1

    limit int64

    Default value: 50

    limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. 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

Responses​

An array of projects

Schema

    items

    object[]

    required

  • 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

    Project specifications

    alerts

    object[]

  • Array [

    • channels

    object[]

  • Array [

    • alertAllUsersboolean
    createdBystring

    http

    object

    bodystring

    headers

    property name*string
    methodstring
    urlstring
    identifiersstring[]
    isActiveboolean

    status

    object

    isSucceededboolean
    messagestring
    timedate-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.

    typestring

    Possible values: [email, app, http]

    uidstring

  • ]

    • componentstring

  • ]

    • logoUrlstring

    teams

    undefined[]

  • Array [

    • rolesstring[]
    teamIdstring

  • ]

    • users

    undefined[]

  • Array [

    • rolesstring[]
    userIdstring

  • ]

    • status

    Project status

    cleanUpStatus

    object

    Project cleanup status

    cleanedResourcesstring[]
    msgstring
    statestring
    isDisabledboolean

  • ]

    • 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...