Project

Get Project

Gets a single 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 Kubernetes Project itself.
kube-addon: The Project represents a Kubernetes Addon, which is defined as some software that extends the functionality of the Kubernetes cluster and its API.
kube-operator: The Project represents a Kubernetes [Operator][operator], which is defined as software written specifically against the Kubernetes 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

{project}

{
  "$schema": "https://example.com/schemas/Project.json",
  "aliases": [
    "prom"
  ],
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "proj_260fc3e8-1acb-4268-8a63-447792b0c2f4",
  "last_modified_by": "<string>",
  "last_modified_on": "2023-11-07T05:31:56Z",
  "title": "Prometheus",
  "type": "application-service",
  "versioning": {
    "release_cycle": "regular",
    "release_interval_days": 1,
    "scheme": "semantic",
    "support_model": "rolling"
  }
}

Response

200

application/json

The response is of type object.

Update ProjectUpdate an existing 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 Kubernetes Project itself. * kube-addon: The Project represents a Kubernetes Addon, which is defined as some software that extends the functionality of the Kubernetes cluster and its API. * kube-operator: The Project represents a Kubernetes [Operator][operator], which is defined as software written specifically against the Kubernetes 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.

{
  "$schema": "https://example.com/schemas/Project.json",
  "aliases": [
    "prom"
  ],
  "created_by": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "proj_260fc3e8-1acb-4268-8a63-447792b0c2f4",
  "last_modified_by": "<string>",
  "last_modified_on": "2023-11-07T05:31:56Z",
  "title": "Prometheus",
  "type": "application-service",
  "versioning": {
    "release_cycle": "regular",
    "release_interval_days": 1,
    "scheme": "semantic",
    "support_model": "rolling"
  }
}

API Reference

Login

Risk

Account

KubeCluster

KubePlatform

OCI

Organization

Package

Project

Get Project

Response