Servers : Swarm Servers API

From Swarm 2022.2, Swarm no longer supports APIs older than v9.

Get a list of servers

Summary

Gets a list of servers

GET /api/v9/servers/

Description

Gets a list of servers

Example response

Successful Response:

HTTP/1.1 200 OK

{
  "servers": {
    "Main": {
     "port": "ssl:10.33.44.55:1666"
    },
    "Artifacts": {
     "port": "10.55.66.77:1666"
    }
  }
}

Example usage

Get a list of servers

Get a list of servers that Swarm is aware of

curl -u "username:password" "https://myswarm.url/api/v9/servers/"

If multiple p4d are configured it will give an output like

HTTP/1.1 200 OK

{
  "servers": {
    "Main": {
       "port": "ssl:10.33.44.55:1666"
    },
    "Artifacts": {
       "port": "10.55.66.77:1666"
    }
  }
}

If a single p4d is configured it will give an output like

HTTP/1.1 200 OK

{
  "servers": {
    "p4": {
       "port": "ssl:10.33.44.55:1666"
    }
  }
}