# Collections

# Creating A Collection

  1. Navigate to a workspace and select DB.
  2. Navigate to the database for which you want to create a collection.
  3. Select Create a Collection.
  4. Enter the URL Name name for the collection.
  5. Enter the Display Name for the collection.
  6. Select Create.

Create Collection Screenshot
Create Collection Screenshot

curl -XPOST "https://db.dashkite.io/db/{db}/collections" \
    -H "Authorization: {api-key}" \
    -H 'Content-Type: application/json' \
    -d '{"collection": "{collection}", "name": "{name}" }'  
Parameter Description
db The database address. You can get the database address from the Web app or from the API response when you create the database.
collection The collection byname.
name The collection display name.
api-key Your API key, which allows you to access your databases. You can get your API key from the Web application.

# Listing Collections

  1. Navigate to a workspace and select DB.
  2. Navigate to the database whose collections you want to list.
  3. A list of collections for the given database will be shown.

List Collections Screenshot
List Collections Screenshot

Parameters you supply are delimited by angle brackets. Example: {db}.

curl -XGET "https://db.dashkite.io/db/{db}/collections" \
    -H "Authorization: {api-key}" \
    -H 'Accept: application/json'
Parameter Description
db The database address. You can get the database address from the Web app or from the API response when you create the database.
collection The collection byname.
api-key Your API key, which allows you to access your databases. You can get your API key from the Web application.

# Getting A Collection

  1. Navigate to a workspace and select DB.
  2. Navigate to the database for which you want to get a collection.
  3. A list of collections for the given database will be shown.
  4. Select a collection to view its details.

Get Collection Screenshot
Get Collection Screenshot

Parameters you supply are delimited by angle brackets. Example: {db}.

curl -XGET "https://db.dashkite.io/db/{db}/collections/{collection}" \
    -H "Authorization: {api-key}" \
    -H 'Accept: application/json'
Parameter Description
db The database address. You can get the database address from the Web app or from the API response when you create the database.
collection The collection byname.
api-key Your API key, which allows you to access your databases. You can get your API key from the Web application.

# Updating A Collection

  1. Navigate to a workspace and select DB.
  2. Navigate to the database for which you want to update a collection.
  3. Select the collection you want to update.
  4. Select Edit Collection.
  5. Enter the Display Name for the collection.
  6. Select Save.

Update Collection Screenshot
Update Collection Screenshot

Parameters you supply are delimited by angle brackets. Example: {db}.

curl -XPUT "https://db.dashkite.io/db/{db}/collections/{collection}" \
    -H "Authorization: {api-key}" \
    -H 'Content-Type: application/json' \
    -d '{"collection": "{collection}", "name": "{name}" }'  
Parameter Description
db The database address. You can get the database address from the Web app or from the API response when you create the database.
collection The collection byname.
name The collection display name.
api-key Your API key, which allows you to access your databases. You can get your API key from the Web application.

# Removing A Collection

  1. Navigate to a workspace and select DB.
  2. Navigate to the database for which you want to remove a collection.
  3. Select the collection you want to remove.
  4. Select Edit Collection.
  5. Select Delete Collection.
  6. Select Delete Collection again to confirm.

Update Collection Screenshot
Update Collection Screenshot

Parameters you supply are delimited by angle brackets. Example: {db}.

curl -XDELETE "https://db.dashkite.io/db/{db}/collections/{collection}" \
    -H "Authorization: {api-key}"
Parameter Description
db The database address. You can get the database address from the Web app or from the API response when you create the database.
collection The collection byname.
api-key Your API key, which allows you to access your databases. You can get your API key from the Web application.