From af8f00b3eb2ad7f789b74f32a5e383c54678253b Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Thu, 25 Aug 2022 17:59:49 -0700 Subject: [PATCH] added ha information to the API endpoints docs --- website/content/docs/nia/api/status.mdx | 4 ++-- website/content/docs/nia/api/tasks.mdx | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/website/content/docs/nia/api/status.mdx b/website/content/docs/nia/api/status.mdx index edfd512072..a129aa3215 100644 --- a/website/content/docs/nia/api/status.mdx +++ b/website/content/docs/nia/api/status.mdx @@ -6,9 +6,9 @@ description: >- --- # Status -The `/status` endpoints share status-related information for tasks. This information is available for understanding the status of individual tasks and across tasks. +The `/status` endpoints return status-related information for tasks. This endpoint returns a count of successful and failed task events that are recorded whenever tasks execute an automation. Currently, only the five most recent events are stored in Consul-Terraform-Sync (CTS). For more information on the hierarchy of status information and how it is collected, see [Status Information](/docs/nia/tasks#status-information). -The health status value is determined by aggregating the success or failure of the event of a task detecting changes in Consul services and then updating network infrastructure. Currently, only the 5 most recent events are stored in Consul-Terraform-Sync (CTS). For more information on the hierarchy of status information and how it is collected, see [Status Information](/docs/nia/tasks#status-information). +If you [run CTS with high availability enabled](/docs/nia/usage/run-ha), you can send requests to the `/status` endpoint on CTS leader or follower instances, but requests to a follower instance return a 400 Bad Request and error message. The error message depends on what information the follower instance is able to obtain about the leader. Refer to [Error Messages](/docs/nia/usage/errors-ref) for more information. ## Overall Status diff --git a/website/content/docs/nia/api/tasks.mdx b/website/content/docs/nia/api/tasks.mdx index b870d26718..0e871224d8 100644 --- a/website/content/docs/nia/api/tasks.mdx +++ b/website/content/docs/nia/api/tasks.mdx @@ -9,6 +9,8 @@ description: >- The `/tasks` endpoints interact with the tasks that Consul-Terraform-Sync (CTS) is responsible for running. +If you [run CTS with high availability enabled](/docs/nia/usage/run-ha), you can send requests to the `/tasks` endpoint on CTS leader or follower instances, but requests to a follower instance return a 400 Bad Request and error message. The error message depends on what information the follower instance is able to obtain about the leader. Refer to [Error Messages](/docs/nia/usage/errors-ref) for more information. + ## Get Tasks This endpoint returns information about all existing tasks.