Sign in
External Services - Query

Get information about a specific container

get/external-services/{service_id}/query/containers/{path}/info

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/external-services/{service_id}/query/containers/{path}/info
  • Auth: HTTP bearer

Path parameters

service_idinteger required
pathstring required

Response

Container information

can_contain_containersboolean required

Can this container hold other containers?

can_contain_entitiesboolean required

Can this container hold entities (tables, collections, etc.)?

child_container_typestring nullable

Type of child containers (if can_contain_containers is true)

container_typestring required

Container type (database, schema, keyspace, bucket, etc.)

entity_count_hintstring nullable

Hint for UI on expected entity count (small = sidebar, large = pagination)

entity_type_labelstring nullable

Label for entity type (if can_contain_entities is true)

metadataunknown required
namestring required

Container name

Example response

{
  "can_contain_containers": true,
  "child_container_type": "schema",
  "container_type": "database",
  "entity_count_hint": "large",
  "entity_type_label": "table",
  "name": "mydb"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.