Returns the specified project

GET 
/v1/projects/:uid

Returns the specified project

Request

Path Parameters

uid stringrequired

Responses

200

OK

application/json

Schema

Schema

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

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:58.311Z",
    "deletionTimestamp": "2024-07-02T18:20:58.311Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:58.311Z",
    "name": "string",
    "uid": "string"
  },
  "spec": {
    "alerts": [
      {
        "channels": [
          {
            "alertAllUsers": true,
            "createdBy": "string",
            "http": {
              "body": "string",
              "method": "string",
              "url": "string"
            },
            "identifiers": [
              "string"
            ],
            "isActive": true,
            "status": {
              "isSucceeded": true,
              "message": "string",
              "time": "2024-07-02T18:20:58.311Z"
            },
            "type": "email",
            "uid": "string"
          }
        ],
        "component": "string"
      }
    ],
    "logoUrl": "string",
    "teams": [
      {
        "roles": [
          "string"
        ],
        "teamId": "string"
      }
    ],
    "users": [
      {
        "roles": [
          "string"
        ],
        "userId": "string"
      }
    ]
  },
  "status": {
    "cleanUpStatus": {
      "cleanedResources": [
        "string"
      ],
      "msg": "string",
      "state": "string"
    },
    "isDisabled": true
  }
}

Loading...