V1/admin

Ping server

get

Ping the server to retrieve basic information about it. This endpoint is always up regardless of whether the server is in maintenance mode.

Authorizations

Bearer-AuthorizationBearer-Authorization-OrganizationAPI-Key-Authorization-KeyAPI-Key-Authorization-IDAPI-Key-Authorization-UserID

Path parameters

organizationstringRequired

Header parameters

x-mongo-cluster-nameany ofOptional

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

stringOptional

or

nullOptional

Responses

200

Succeeded.

application/json

404

The specified organization does not exist.

422

Invalid request path parameter failed validation.

get

HTTPcURLJavaScriptPython

GET /v1/{organization}/admin/ping HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*

{
  "in_maintenance_mode": true
}