Siren APIs

Documentation of our Siren API with gRPC and gRPC-Gateway.

Version: 0.5

/v1beta1/alerts/{provider_type}/{provider_id}

GET

Summary

list alerts

Parameters

Name	Located in	Description	Required	Schema
provider_type	path		Yes	string
provider_id	path		Yes	string (uint64)
resource_name	query		No	string
start_time	query		No	string (uint64)
end_time	query		No	string (uint64)
namespace_id	query		No	string (uint64)
silence_id	query		No	string

Responses

Code	Description	Schema
200	A successful response.	ListAlertsResponse
default	An unexpected error response.	Status

POST

Summary

create alerts

Parameters

Name	Located in	Description	Required	Schema
provider_type	path		Yes	string
provider_id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	CreateAlertsResponse
default	An unexpected error response.	Status

/v1beta1/alerts/{provider_type}/{provider_id}/{namespace_id}

POST

Summary

create alerts with namespace

Parameters

Name	Located in	Description	Required	Schema
provider_type	path		Yes	string
provider_id	path		Yes	string (uint64)
namespace_id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	CreateAlertsWithNamespaceResponse
default	An unexpected error response.	Status

/v1beta1/namespaces

GET

Summary

list namespaces

Responses

Code	Description	Schema
200	A successful response.	ListNamespacesResponse
default	An unexpected error response.	Status

POST

Summary

create a namespace

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CreateNamespaceRequest

Responses

Code	Description	Schema
200	A successful response.	CreateNamespaceResponse
default	An unexpected error response.	Status

/v1beta1/namespaces/{id}

GET

Summary

get a namespace

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	GetNamespaceResponse
default	An unexpected error response.	Status

DELETE

Summary

delete a namespace

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	DeleteNamespaceResponse
default	An unexpected error response.	Status

PUT

Summary

update a namespace

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	UpdateNamespaceResponse
default	An unexpected error response.	Status

/v1beta1/providers

GET

Summary

list providers

Parameters

Name	Located in	Description	Required	Schema
urn	query		No	string
type	query		No	string

Responses

Code	Description	Schema
200	A successful response.	ListProvidersResponse
default	An unexpected error response.	Status

POST

Summary

create a provider

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CreateProviderRequest

Responses

Code	Description	Schema
200	A successful response.	CreateProviderResponse
default	An unexpected error response.	Status

/v1beta1/providers/{id}

GET

Summary

get a provider

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	GetProviderResponse
default	An unexpected error response.	Status

DELETE

Summary

delete a provider

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	DeleteProviderResponse
default	An unexpected error response.	Status

PUT

Summary

update a provider

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	UpdateProviderResponse
default	An unexpected error response.	Status

/v1beta1/receivers

GET

Summary

list receivers

Responses

Code	Description	Schema
200	A successful response.	ListReceiversResponse
default	An unexpected error response.	Status

POST

Summary

create a receiver

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CreateReceiverRequest

Responses

Code	Description	Schema
200	A successful response.	CreateReceiverResponse
default	An unexpected error response.	Status

/v1beta1/receivers/{id}

GET

Summary

get a receiver

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	GetReceiverResponse
default	An unexpected error response.	Status

DELETE

Summary

delete a receiver

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	DeleteReceiverResponse
default	An unexpected error response.	Status

PUT

Summary

update a receiver

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	UpdateReceiverResponse
default	An unexpected error response.	Status

/v1beta1/receivers/{id}/send

POST

Summary

send notification to receiver

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	NotifyReceiverResponse
default	An unexpected error response.	Status

/v1beta1/rules

GET

Summary

list rules

Parameters

Name	Located in	Description	Required	Schema
name	query		No	string
namespace	query		No	string
group_name	query		No	string
template	query		No	string
provider_namespace	query		No	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	ListRulesResponse
default	An unexpected error response.	Status

PUT

Summary

add/update a rule

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	UpdateRuleRequest

Responses

Code	Description	Schema
200	A successful response.	UpdateRuleResponse
default	An unexpected error response.	Status

/v1beta1/silences

GET

Summary

get all silences

Parameters

Name	Located in	Description	Required	Schema
subscription_id	query		No	string (uint64)
namespace_id	query		No	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	ListSilencesResponse
default	An unexpected error response.	Status

POST

Summary

create a silence

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CreateSilenceRequest

Responses

Code	Description	Schema
200	A successful response.	CreateSilenceResponse
default	An unexpected error response.	Status

/v1beta1/silences/{id}

GET

Summary

get a silence

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	GetSilenceResponse
default	An unexpected error response.	Status

DELETE

Summary

expire a silence

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	ExpireSilenceResponse
default	An unexpected error response.	Status

/v1beta1/subscriptions

GET

Summary

List subscriptions

Parameters

Name	Located in	Description	Required	Schema
namespace_id	query		No	string (uint64)
silence_id	query		No	string

Responses

Code	Description	Schema
200	A successful response.	ListSubscriptionsResponse
default	An unexpected error response.	Status

POST

Summary

Create a subscription

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	CreateSubscriptionRequest

Responses

Code	Description	Schema
200	A successful response.	CreateSubscriptionResponse
default	An unexpected error response.	Status

/v1beta1/subscriptions/{id}

GET

Summary

Get a subscription

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	GetSubscriptionResponse
default	An unexpected error response.	Status

DELETE

Summary

Delete a subscription

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)

Responses

Code	Description	Schema
200	A successful response.	DeleteSubscriptionResponse
default	An unexpected error response.	Status

PUT

Summary

Update a subscription

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	string (uint64)
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	UpdateSubscriptionResponse
default	An unexpected error response.	Status

/v1beta1/templates

GET

Summary

list templates

Parameters

Name	Located in	Description	Required	Schema
tag	query		No	string

Responses

Code	Description	Schema
200	A successful response.	ListTemplatesResponse
default	An unexpected error response.	Status

PUT

Summary

add/update a template

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	UpsertTemplateRequest

Responses

Code	Description	Schema
200	A successful response.	UpsertTemplateResponse
default	An unexpected error response.	Status

/v1beta1/templates/{name}

GET

Summary

get a template

Parameters

Name	Located in	Description	Required	Schema
name	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	GetTemplateResponse
default	An unexpected error response.	Status

DELETE

Summary

delete a template

Parameters

Name	Located in	Description	Required	Schema
name	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	DeleteTemplateResponse
default	An unexpected error response.	Status

/v1beta1/templates/{name}/render

POST

Summary

render a template

Parameters

Name	Located in	Description	Required	Schema
name	path		Yes	string
body	body		Yes	object

Responses

Code	Description	Schema
200	A successful response.	RenderTemplateResponse
default	An unexpected error response.	Status

Models

Alert

Name	Type	Description	Required
id	string (uint64)		No
metric_name	string		No
metric_value	string		No
namespace_id	string (uint64)		No
provider_id	string (uint64)		No
resource_name	string		No
rule	string		No
severity	string		No
silence_status	string		No
triggered_at	dateTime		No

Any

Name	Type	Description	Required
@type	string		No

CreateAlertsResponse

Name	Type	Description	Required
alerts	[ Alert ]		No

CreateAlertsWithNamespaceResponse

Name	Type	Description	Required
alerts	[ Alert ]		No

CreateNamespaceRequest

Name	Type	Description	Required
created_at	dateTime		No
credentials	object		No
labels	object		No
name	string		No
provider	string (uint64)		No
updated_at	dateTime		No
urn	string		No

CreateNamespaceResponse

Name	Type	Description	Required
id	string (uint64)		No

CreateProviderRequest

Name	Type	Description	Required
credentials	object		No
host	string		No
labels	object		No
name	string		No
type	string		No
urn	string		No

CreateProviderResponse

Name	Type	Description	Required
id	string (uint64)		No

CreateReceiverRequest

Name	Type	Description	Required
configurations	object		No
labels	object		No
name	string		No
type	string		No

CreateReceiverResponse

Name	Type	Description	Required
id	string (uint64)		No

CreateSilenceRequest

Name	Type	Description	Required
namespace_id	string (uint64)		No
target_expression	object		No
target_id	string (uint64)		No
type	string		No

CreateSilenceResponse

Name	Type	Description	Required
id	string		No

CreateSubscriptionRequest

Name	Type	Description	Required
match	object		No
namespace	string (uint64)		No
receivers	[ ReceiverMetadata ]		No
urn	string		No

CreateSubscriptionResponse

Name	Type	Description	Required
id	string (uint64)		No

DeleteNamespaceResponse

Name	Type	Description	Required
DeleteNamespaceResponse	object

DeleteProviderResponse

Name	Type	Description	Required
DeleteProviderResponse	object

DeleteReceiverResponse

Name	Type	Description	Required
DeleteReceiverResponse	object

DeleteSubscriptionResponse

Name	Type	Description	Required
DeleteSubscriptionResponse	object

DeleteTemplateResponse

Name	Type	Description	Required
DeleteTemplateResponse	object

ExpireSilenceResponse

Name	Type	Description	Required
ExpireSilenceResponse	object

GetNamespaceResponse

Name	Type	Description	Required
namespace	Namespace		No

GetProviderResponse

Name	Type	Description	Required
provider	Provider		No

GetReceiverResponse

Name	Type	Description	Required
receiver	Receiver		No

GetSilenceResponse

Name	Type	Description	Required
silence	Silence		No

GetSubscriptionResponse

Name	Type	Description	Required
subscription	Subscription		No

GetTemplateResponse

Name	Type	Description	Required
template	Template		No

ListAlertsResponse

Name	Type	Description	Required
alerts	[ Alert ]		No

ListNamespacesResponse

Name	Type	Description	Required
namespaces	[ Namespace ]		No

ListProvidersResponse

Name	Type	Description	Required
providers	[ Provider ]		No

ListReceiversResponse

Name	Type	Description	Required
receivers	[ Receiver ]		No

ListRulesResponse

Name	Type	Description	Required
rules	[ Rule ]		No

ListSilencesResponse

Name	Type	Description	Required
silences	[ Silence ]		No

ListSubscriptionsResponse

Name	Type	Description	Required
subscriptions	[ Subscription ]		No

ListTemplatesResponse

Name	Type	Description	Required
templates	[ Template ]		No

Namespace

Name	Type	Description	Required
created_at	dateTime		No
credentials	object		No
id	string (uint64)		No
labels	object		No
name	string		No
provider	string (uint64)		No
updated_at	dateTime		No
urn	string		No

NotifyReceiverResponse

Name	Type	Description	Required
NotifyReceiverResponse	object

NullValue

NullValue is a singleton enumeration to represent the null value for the Value type union.

The JSON representation for NullValue is JSON null.

• NULL_VALUE: Null value.

Name	Type	Description	Required
NullValue	string	NullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null. - NULL_VALUE: Null value.

Provider

Name	Type	Description	Required
created_at	dateTime		No
credentials	object		No
host	string		No
id	string (uint64)		No
labels	object		No
name	string		No
type	string		No
updated_at	dateTime		No
urn	string		No

Receiver

Name	Type	Description	Required
configurations	object		No
created_at	dateTime		No
data	object		No
id	string (uint64)		No
labels	object		No
name	string		No
type	string		No
updated_at	dateTime		No

ReceiverMetadata

Name	Type	Description	Required
configuration	object		No
id	string (uint64)		No

RenderTemplateResponse

Name	Type	Description	Required
body	string		No

Rule

Name	Type	Description	Required
created_at	dateTime		No
enabled	boolean		No
group_name	string		No
id	string (uint64)		No
name	string		No
namespace	string		No
provider_namespace	string (uint64)		No
template	string		No
updated_at	dateTime		No
variables	[ Variables ]		No

Silence

Name	Type	Description	Required
created_at	dateTime		No
deleted_at	dateTime		No
id	string		No
namespace_id	string (uint64)		No
target_expression	object		No
target_id	string (uint64)		No
type	string		No
updated_at	dateTime		No

Status

Name	Type	Description	Required
code	integer		No
details	[ Any ]		No
message	string		No

Subscription

Name	Type	Description	Required
created_at	dateTime		No
id	string (uint64)		No
match	object		No
namespace	string (uint64)		No
receivers	[ ReceiverMetadata ]		No
updated_at	dateTime		No
urn	string		No

Template

Name	Type	Description	Required
body	string		No
created_at	dateTime		No
id	string (uint64)		No
name	string		No
tags	[ string ]		No
updated_at	dateTime		No
variables	[ TemplateVariables ]		No

TemplateVariables

Name	Type	Description	Required
default	string		No
description	string		No
name	string		No
type	string		No

UpdateNamespaceResponse

Name	Type	Description	Required
id	string (uint64)		No

UpdateProviderResponse

Name	Type	Description	Required
id	string (uint64)		No

UpdateReceiverResponse

Name	Type	Description	Required
id	string (uint64)		No

UpdateRuleRequest

Name	Type	Description	Required
enabled	boolean		No
group_name	string		No
namespace	string		No
provider_namespace	string (uint64)		No
template	string		No
variables	[ Variables ]		No

UpdateRuleResponse

Name	Type	Description	Required
rule	Rule		No

UpdateSubscriptionResponse

Name	Type	Description	Required
id	string (uint64)		No

UpsertTemplateRequest

Name	Type	Description	Required
body	string		No
id	string (uint64)		No
name	string		No
tags	[ string ]		No
variables	[ TemplateVariables ]		No

UpsertTemplateResponse

Name	Type	Description	Required
id	string (uint64)		No

Variables

Name	Type	Description	Required
description	string		No
name	string		No
type	string		No
value	string		No