Database Information
get
/v1/graphs/{graph_id}/infoPart of Graph Info.
Authentication
Authenticate in any one of these ways — not all of them:
- API key in the
X-API-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph Id |
Example request
curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/info" \
-H "X-API-Key: $ROBOSYSTEMS_API_KEY"Responses
200 Successful Response
| Field | Type | Description |
|---|---|---|
graph_idrequired | string | Graph database identifier |
database_namerequired | string | Database name |
database_size_bytesrequired | integer | Database size in bytes |
database_size_mbrequired | number | Database size in MB |
node_countrequired | integer | Total number of nodes |
relationship_countrequired | integer | Total number of relationships |
node_labelsrequired | string[] | List of node labels |
relationship_typesrequired | string[] | List of relationship types |
created_atrequired | string | Database creation timestamp |
last_modifiedrequired | string | Last modification timestamp |
schema_versionoptional | string | Schema version |
read_onlyrequired | boolean | Whether database is read-only |
backup_countrequired | integer | Number of available backups |
last_backup_dateoptional | string | Date of last backup |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 422 | Validation Error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |