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 are system generated key value metadata for the resource. As an input certain annotations like description can be set

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

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

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 of the resource

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

Populated by the system. Read-only.

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": "2023-12-01T21:31:48.698Z",
    "deletionTimestamp": "2023-12-01T21:31:48.698Z",
    "labels": {},
    "lastModifiedTimestamp": "2023-12-01T21:31:48.698Z",
    "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": "2023-12-01T21:31:48.698Z"
            },
            "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...