Browse the API reference

Database Information

get/v1/graphs/{graph_id}/info

Part of Graph Info.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph 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

FieldTypeDescription
graph_idrequiredstring

Graph database identifier

database_namerequiredstring

Database name

database_size_bytesrequiredinteger

Database size in bytes

database_size_mbrequirednumber

Database size in MB

node_countrequiredinteger

Total number of nodes

relationship_countrequiredinteger

Total number of relationships

node_labelsrequiredstring[]

List of node labels

relationship_typesrequiredstring[]

List of relationship types

created_atrequiredstring

Database creation timestamp

last_modifiedrequiredstring

Last modification timestamp

schema_versionoptionalstring

Schema version

read_onlyrequiredboolean

Whether database is read-only

backup_countrequiredinteger

Number of available backups

last_backup_dateoptionalstring

Date of last backup

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error