Project

Create Project

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

POST

projects

Create Project

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

{
  "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
  }
}

Response

Created

created_by

string

required

user who created the record.

created_on

string<date-time>

required

timestamp of when the record was created.

string

required

ID is the unique identifier for the Project

Example:

"proj_260fc3e8-1acb-4268-8a63-447792b0c2f4"

last_modified_by

string

required

user who last modified the record.

last_modified_on

string<date-time>

required

timestamp of when the record was last modified.

title

string

required

Display name for the Project.

Example:

"Prometheus"

type

enum<string>

required

Type is the type of Project.

Available options:

kube-addon,

kube-operator,

kube-control-plane-provider,

application-service,

platform,

application

Example:

"application-service"

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

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

aliases

string[] | null

Optional set of string aliases for the Project. Must be globally unique.

Example:

["prom"]

description

string

Optional long-form description of the Project.

versioning

object

An optional object containing information about the Project's versioning and release model.

Show child attributes

Get ProjectGets 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 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

Create Project

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

{
  "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
  }
}

Documentation Index

Response