Skip to content

Latest commit



56 lines (38 loc) · 1.27 KB

File metadata and controls

56 lines (38 loc) · 1.27 KB

REST API: POST database

This method is used to create a new database with the REST API. It uses an HTTP POST request to the following address:

After a successful call the ID of the created request is returned.

Available parameters

  • name: name of the new database
  • description: optional description of the database
  • archived: optional boolean value to archive the database upon creation

JSON example

The following JSON demonstrates how to use the API method:

    "name": "my_test_database",
    "description": "database description",
    "archived": false

PHP example

The following PHP script demonstrates how to use the API method:

// dependencies

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);

// data to be sent to the api
$data = array(
    'name'          =>  'my_test_database',
    'description'   =>  'a description of the database'

// do the call
$api->post("databases", $data);

// return id of created request if successful

The example above requires the CopernicaRestApi class.

More information