https://github.com/m-lab/autojoin

Autojoin API
https://github.com/m-lab/autojoin

Last synced: about 1 month ago
JSON representation

Autojoin API

• Host: GitHub
• URL: https://github.com/m-lab/autojoin
• Owner: m-lab
• License: apache-2.0
• Created: 2024-02-06T19:58:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-07T21:57:29.000Z (about 2 months ago)
• Last Synced: 2025-04-28T15:31:27.776Z (about 1 month ago)
• Language: Go
• Size: 365 KB
• Stars: 0
• Watchers: 9
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

| branch | coveralls | docs | report card |

|--------|-----------|------|-------------|

| main   | [![Coverage Status](https://coveralls.io/repos/github/m-lab/autojoin/badge.svg?branch=main)](https://coveralls.io/github/m-lab/autojoin?branch=main) | [![GoDoc](https://godoc.org/github.com/m-lab/autojoin?status.svg)](https://godoc.org/github.com/m-lab/autojoin) | [![Go Report Card](https://goreportcard.com/badge/github.com/m-lab/autojoin)](https://goreportcard.com/report/github.com/m-lab/autojoin)

# Autojoin API

## List Nodes

The Autojoin API allows listing all known servers for various reasons:

### Request Parameters

Node list operations use the same base url and supports multiple output formats.

Base: `https://autojoin.measurementlab.net/autojoin/v0/node/list`

Formats:

* `format=script-exporter` - output format used by script-exporter.

* `format=prometheus` - output format used by prometheus to scrape metrics.

* `format=servers` - simple list known server names.

* `format=sites` - simple list known site names.

* `org=` - limit results the given organization.

For example, a client could list all known sites associated with org "foo":

* `https://autojoin.measurementlab.net/autojoin/v0/node/list?format=sites&org=foo`