REST API

POST 🔒 and PUT 🔒 methods are guarded by API key in header "Authorization"

Swagger

Method	Endpoint
GET	/docs

Maintenance

Method	Endpoint
GET	/health
GET	/metrics
GET	/zio-metrics

Service - Configuration

Method	Endpoint	Info
GET	/api/v1/configurations	Get current configuration for all services
GET	/api/v1/configurations?include-hidden=false	Get current configuration for all non-hidden services
GET	/api/v1/configurations/{env}/{serviceName}	Get current service configuration
GET	/api/v1/configurations/{env}/{serviceName}/dependencies	Get list of all dependencies of this configuration
GET	/api/v1/configurations/{env}/{serviceName}/dependents	Get list of all dependents of this configuration
POST 🔒	/api/v1/configurations	Create new service configuration (fails if already exist)
PUT 🔒	/api/v1/configurations/{env}/{serviceName}	Overwrite existing service configuration (fails if not exist, otherwise idempotent)
POST 🔒	/api/v1/configurations/{env}/{serviceName}/new-name	Overwrite existing service configuration including new name, perform name changes in whole history, perform necessary monitoring restarts during the operation.
PUT 🔒	/api/v1/configurations/{env}/{serviceName}/message?message={maintenance-message}	Set maintenance-message for given service, perform necessary monitoring restart. Idempotent
PUT 🔒	/api/v1/configurations/{env}/{serviceName}/temporary-state?status={temporary-status}&message={maintenance-message}	Set temporary fixed state with maintenance-message, perform necessary monitoring restart. Idempotent
POST 🔒	/api/v1/configurations/{env}/{serviceName}/restore	Restore monitoring from temporary fixed state, reset maintenance message, perform necessary monitoring restart. Idempotent
DELETE 🔒	/api/v1/configurations/{env}/{serviceName}	Remove service configuration, mark state as black and stop monitoring for given service. Idempotent

Service - Status

Method	Endpoint	Info
GET	/api/v1/statuses/{env}/{serviceName}/latest	Get latest service status (or 404)
GET	/api/v1/statuses/{env}/{serviceName}	Get whole history of service statuses (or 404)
GET	/api/v1/statuses	Get latest status of all active services

Service - Monitoring

Method	Endpoint	Info
POST 🔒	/api/v1/monitoring/restart	Restart monitoring for all service configurations
POST 🔒	/api/v1/monitoring/restart/{env}/{serviceName}	Restart monitoring for given service