Projects

https://api.spectrocloud.com/v1/projects

summary:
Retrieves a list of projects
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws Server will be restricted to certain fields based on the indexed data for each resource.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.no
offsetintegeroffset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.no
continuestringcontinue token to paginate the subsequent data itemsno
200
An array of projects
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"alerts": [
{
"channels": [
{
"alertAllUsers": "boolean",
"http": {
"body": "string",
"method": "string",
"url": "string"
},
"identifiers": [
"string"
],
"isActive": "boolean",
"status": {
"isSucceeded": "boolean",
"message": "string",
"time": "date-time"
},
"type": "string"
}
],
"component": "string"
}
],
"logoUrl": "string",
"teams": [
{
"roles": [
"string"
],
"teamId": "string"
}
],
"users": [
{
"roles": [
"string"
],
"userId": "string"
}
]
},
"status": "object"
}
],
"listmeta": {
"continue": "string",
"count": "integer",
"limit": "integer",
"offset": "integer"
}
}

https://api.spectrocloud.com/v1/projects

summary:
Creates a project
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"logoUid": "string",
"teams": [
{
"roles": [
"string"
],
"teamId": "string"
}
],
"users": [
{
"roles": [
"string"
],
"userId": "string"
}
]
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/projects/alerts

summary:
Retrieves a list of supported alerts for a project
200
An array of alert components
{
"components": [
{
"description": "string",
"name": "string",
"supportedChannels": [
"string"
]
}
]
}

https://api.spectrocloud.com/v1/projects/{uid}

summary:
Returns the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"alerts": [
{
"channels": [
{
"alertAllUsers": "boolean",
"http": {
"body": "string",
"method": "string",
"url": "string"
},
"identifiers": [
"string"
],
"isActive": "boolean",
"status": {
"isSucceeded": "boolean",
"message": "string",
"time": "date-time"
},
"type": "string"
}
],
"component": "string"
}
],
"logoUrl": "string",
"teams": [
{
"roles": [
"string"
],
"teamId": "string"
}
],
"users": [
{
"roles": [
"string"
],
"userId": "string"
}
]
},
"status": "object"
}

https://api.spectrocloud.com/v1/projects/{uid}

summary:
Updates the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"logoUid": "string",
"teams": [
{
"roles": [
"string"
],
"teamId": "string"
}
],
"users": [
{
"roles": [
"string"
],
"userId": "string"
}
]
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}

summary:
Deletes the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/projects/{uid}

summary:
Patches the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"items": {
"from": "string",
"op": "string",
"path": "string",
"value": "object"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}/alerts/{component}

summary:
Upsert the specified alert to the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
componentstringyes
{
"channels": [
{
"alertAllUsers": "boolean",
"http": {
"body": "string",
"method": "string",
"url": "string"
},
"identifiers": [
"string"
],
"isActive": "boolean",
"status": {
"isSucceeded": "boolean",
"message": "string",
"time": "date-time"
},
"type": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}/alerts/{component}

summary:
Deletes the specified alert to the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
componentstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/projects/{uid}/macros

summary:
List the macros of the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}

https://api.spectrocloud.com/v1/projects/{uid}/macros

summary:
Update the macros of the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"macros": [
{
"name": "string",
"value": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}/meta

summary:
Update the metadata of the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"lastModifiedTimestamp": "date-time",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}/teams

summary:
Update the teams association to the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"teams": [
{
"roles": [
"string"
],
"teamId": "string"
}
]
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/projects/{uid}/users

summary:
Update the users association to the specified project
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"users": [
{
"roles": [
"string"
],
"userId": "string"
}
]
}
204
The resource was updated successfully