diff --git a/docs/api/internal/health.md b/docs/api/internal/health.md new file mode 100644 index 0000000000..22e154372c --- /dev/null +++ b/docs/api/internal/health.md @@ -0,0 +1,30 @@ +--- +id: health +title: /health +--- + +# Health API + +`GET http://unleash.host.com/health` + +Used to check the health of the running Unleash instance. This endpoint has two possible responses: + +`Status: 200` + +```json +{ + "health": "GOOD" +} +``` + +This response means everything is OK. Unleash is able to talk to the PostgreSQL + +`Status: 500` + +```json +{ + "health": "BAD" +} +``` + +This response indicates that Unleash is not able to talk to PostgreSQL and will not be able to serve requests. diff --git a/docs/api/internal-backstage-api.md b/docs/api/internal/internal-backstage-api.md similarity index 100% rename from docs/api/internal-backstage-api.md rename to docs/api/internal/internal-backstage-api.md diff --git a/website/i18n/en.json b/website/i18n/en.json index 96bd459bac..092fd7b0bf 100644 --- a/website/i18n/en.json +++ b/website/i18n/en.json @@ -80,7 +80,10 @@ "api/index": { "title": "API Documentation" }, - "api/internal": { + "api/internal/health": { + "title": "/health" + }, + "api/internal/internal": { "title": "/internal-backstage/prometheus" }, "api/open_api": { @@ -196,7 +199,7 @@ }, "categories": { "Getting started": "Getting started", - "Working with your SDK": "Working with your SDK", + "Working with the SDK": "Working with the SDK", "Addons framework": "Addons framework", "Advanced": "Advanced", "Client": "Client", diff --git a/website/sidebars.json b/website/sidebars.json index 614ed3fd63..5b53ba0dc5 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -51,7 +51,7 @@ "api/admin/feature-types", "api/admin/addons" ], - "Internal": ["api/internal"], + "Internal": ["api/internal/internal", "api/internal/health"], "Specification": ["api/open_api"] }, "Deploy and manage": {