Skip to content

Commit

Permalink
Merge pull request #50 from buildkite/make-buildkite-agent-metrics-a-…
Browse files Browse the repository at this point in the history
…proper-noun

Updates to the Agent REST API overview page
  • Loading branch information
gilesgas authored Sep 27, 2024
2 parents fb1a934 + 4a66064 commit 316436c
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions pages/apis/agent_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The agent REST API endpoint is used for agent registration, agent deregistration, starting jobs on agents, finishing jobs on agents, and agent metrics.

The only publicly available endpoint is `/metrics`. The CLI tool [Buildkite agent metrics](https://github.com/buildkite/buildkite-agent-metrics) uses the data returned by the metrics endpoint for agent autoscaling.
The only publicly available endpoint is `/metrics`. The [Buildkite Agent Metrics](https://github.com/buildkite/buildkite-agent-metrics) CLI tool uses the data returned by the metrics endpoint for agent autoscaling.

All other endpoints in the agent API are intended only for use by the Buildkite Agent, therefore stability and backwards compatibility are not guaranteed, and changes won't be announced.

Expand All @@ -17,9 +17,7 @@ curl https://agent.buildkite.com
```

```json
{
"message":"👋"
}
{"message":"👋","timestamp":1719276157}
```

## Authentication
Expand Down

0 comments on commit 316436c

Please sign in to comment.