Project

List Projects

List multiple Projects

A Project is software that provides some functionality.

Projects are uniquely identified by a UUID, prefixed with the string proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8

Projects can have zero or more Aliases. Aliases are completely free-form. They can be a URL, like github.com/kubernetes/kubernetes or a short string like k8s or kube.

Each Project has a ProjectType. Valid ProjectTypes include:

platform: The Project represents a software platform, such as the Project itself.
kube-addon: The Project represents a Cloud Native Project, which is defined as some software that extends the functionality of the cluster and its API.
kube-operator: The Project represents a Kubernetes [Operator][operator], which is defined as software written specifically against the API and is responsible for installing and managing the lifecycle of a Kubernetes Addon or Application Service.
kube-control-plane-provider: The Project represents a Kubernetes control plane service, such as RKE, GKE or EKS.
application-service: The Project represents application code that provides essential services to the rest of the application stack.
application: The Project represents customer-specific or internal code.

A Project is not the packaging of that software. Packaging of Projects is described by the Package model.

GET

projects

List Projects

curl --request GET \
  --url https://api.example.com/projects

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "$schema": "<string>",
      "aliases": [
        "<string>"
      ],
      "description": "<string>",
      "versioning": {
        "release_cycle": "none",
        "scheme": "unknown",
        "support_model": "none",
        "release_interval_days": 1
      }
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Query Parameters

continue

string

Continuation token value (used when retrieving the next page of results).

integer<int64>

Number of records to show per page of results.

Required range: 0 <= x <= 100

filter

string

Record filter.

Response

results

object[] | null

required

Show child attributes

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/ListProjectsOutputBody.json"

pagination

object

Show child attributes

Create ProjectCreate a new Project A Project is software that provides some functionality. Projects are uniquely identified by a UUID, prefixed with the string proj_, for example proj_c42014e7-baf5-4ec6-a502-858f98dca7c8 Projects can have zero or more Aliases. Aliases are completely free-form. They can be a URL, like github.com/kubernetes/kubernetes or a short string like k8s or kube. Each Project has a ProjectType. Valid ProjectTypes include: * platform: The Project represents a software platform, such as the Project itself. * kube-addon: The Project represents a Cloud Native Project, which is defined as some software that extends the functionality of the cluster and its API. * kube-operator: The Project represents a Kubernetes [Operator][operator], which is defined as software written specifically against the API and is responsible for installing and managing the lifecycle of a Kubernetes Addon or Application Service. * kube-control-plane-provider: The Project represents a Kubernetes control plane service, such as RKE, GKE or EKS. * application-service: The Project represents application code that provides essential services to the rest of the application stack. * application: The Project represents customer-specific or internal code. A Project is not the packaging of that software. Packaging of Projects is described by the Package model.

⌘I

List Projects

curl --request GET \
  --url https://api.example.com/projects

{
  "results": [
    {
      "created_by": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "last_modified_by": "<string>",
      "last_modified_on": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "$schema": "<string>",
      "aliases": [
        "<string>"
      ],
      "description": "<string>",
      "versioning": {
        "release_cycle": "none",
        "scheme": "unknown",
        "support_model": "none",
        "release_interval_days": 1
      }
    }
  ],
  "$schema": "<string>",
  "pagination": {
    "continue": "<string>"
  }
}

Documentation Index

Query Parameters

Response