Read known Cloud deployments and versions
GET
cookie
vg_session<token>The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.
orgId*stringAuthorised orgId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthprojectId*stringAuthorised projectId; the server must verify organisation/project ownership before any read.
Length
1 <= lengthAuthorised read result. Null means unreported, never zero. Source-specific coverage limits remain visible.
application/json- response
readAt*stringFormat
date-timesource*stringagents*array<>sourceStatus?How fresh a sampled read is. Present when the worker samples the layer; a layer never read successfully answers 503 source_unavailable instead.
Example Request
curl -X GET 'https://example.com/api/v1/org/string/project/string/agents'Example Response
{ "readAt": "2019-08-24T14:15:22Z", "source": "string", "agents": [ { "id": "string", "name": "string", "version": "string", "deployedAt": "2019-08-24T14:15:22Z", "deployments": [ { "deployment": "string", "region": "string", "serverRegion": "string", "status": "string", "replicas": 0, "minReplicas": 0, "maxReplicas": 0, "curCpu": "string", "cpuReq": "string", "cpuLimit": "string", "curMem": "string", "memReq": "string", "memLimit": "string", "lastScrapedAt": "2019-08-24T14:15:22Z", "version": "string" } ], "versions": [ { "version": "string", "current": true, "draining": true, "active": true, "status": "string", "createdAt": "2019-08-24T14:15:22Z", "deployedAt": "2019-08-24T14:15:22Z" } ] } ], "sourceStatus": { "lastReadAt": "2019-08-24T14:15:22Z", "lastGoodReadAt": "2019-08-24T14:15:22Z", "errorClass": "unauthenticated" }}Was this page helpful?