{"openapi":"3.0.0","info":{"title":"Ping and Server Info","description":"The official SeaTable API Reference (OpenAPI 3.0) - Part \"Ping and Server Info\".","version":"6.1"},"servers":[{"url":"https://{server}","variables":{"server":{"default":"cloud.seatable.io"}}}],"x-readme":{"explorer-enabled":true,"metrics-enabled":false,"proxy-enabled":false},"tags":[{"name":"Info","description":"Retrieve server info"},{"name":"Ping","description":"Ping SeaTable services"}],"components":{"securitySchemes":{"AccountTokenAuth":{"type":"http","scheme":"bearer","description":"This is the [Account-Token](/reference/authentication)."}},"schemas":{"ping_response":{"type":"string","description":"if successful, this api returns just the string `pong`","example":"pong"},"ping_response_object":{"type":"object","properties":{"ret":{"type":"string","example":"pong"}},"required":["ret"]},"server_info":{"type":"object","description":"get server info like the version and the edition","properties":{"version":{"type":"string","description":"current version number of SeaTable Server"},"edition":{"type":"string","description":"current edition of SeaTable Server"}},"example":{"version":"3.4.8","edition":"enterprise edition"}}}},"paths":{"/server-info/":{"get":{"tags":["Info"],"summary":"Get SeaTable Server Info","operationId":"getServerInfo","description":"Use this anonymous call to retrieve the current SeaTable server version information. The response includes the current version number and the type of subscription.","responses":{"200":{"description":"Return version and edition of SeaTable Server","content":{"application/json":{"schema":{"$ref":"#/components/schemas/server_info"}}}}}}},"/api2/ping/":{"get":{"tags":["Ping"],"summary":"Ping Server","operationId":"pingServer","description":"Check the server status.","responses":{"200":{"description":"Service is available and running","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ping_response"}}}}}}},"/api2/auth/ping/":{"get":{"tags":["Ping"],"summary":"Ping Server (with authentication)","operationId":"pingServerWithAuth","description":"Executes two checks against SeaTable server:\n- check the validity of the Account-Token \n- check the status of SeaTable Server\n","security":[{"AccountTokenAuth":[]}],"responses":{"200":{"description":"Access granted and service is available and running","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ping_response"}}}}}}},"/dtable-server/ping/":{"get":{"tags":["Ping"],"summary":"Ping dtable Server","operationId":"pingDtableServer","description":"Check the status of the dtable-server. Base related operations are carried out by the dtable-server. These operations are included in the section **Base Operations**.","responses":{"200":{"description":"Service is available and running","content":{"text/html":{"schema":{"type":"string","example":"pong"}}}}}}},"/dtable-db/ping/":{"get":{"tags":["Ping"],"summary":"Ping dtable-db Server","operationId":"pingDtableDbServer","description":"Check the status of the dtable-db server.","responses":{"200":{"description":"Service is available and running","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ping_response_object"}}}}}}},"/api-gateway/api/v2/ping/":{"get":{"tags":["Ping"],"summary":"Ping API Gateway","operationId":"pingApiGateway","description":"Check the status of the API gateway.","responses":{"200":{"description":"Service is available and running","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ping_response_object"}}}}}}}}}