const Nubi = require('nubi');
const nubi = new Nubi();
nubi.api.tasks.listTasks({ site: '{MYSITE}' })
.then(console.log)
.catch(console.log)
Authentication - You can either pass NUBI_USERNAME
& NUBI_PASSWORD
containing your basic authentication credentials with each request, or specify them in your environment and they will be automatically used with each request. The credentials-as-arguments take precedence over environment variables if both are present.
All methods accept a single object as an argument with the parameters
as keys
. These are used for replacements in template strings.
-
List a site's tasks.
Parameters:
site
- The site name.
-
Get a task record.
Parameters:
site
- The site name.task
- The task id.
-
List a site environment's servers.
Parameters:
site
- The site name.env
- The environment name.
-
Get a server record.
Parameters:
site
- The site name.env
- The environment name.server
- The server name.
-
Calculate a server's PHP max processes record.
Parameters:
site
- The site name.env
- The environment name.server
- The server name.
-
Delete a domain.
Parameters:
site
- The site name.env
- The environment name.domain
- The domain name to delete.
-
Purge the Varnish cache for a domain.
Parameters:
site
- The site name.env
- The environment name.domain
- The domain name to purge.
-
List an environment's domains.
Parameters:
site
- The site name.env
- The environment name.
-
Get a domain record.
Parameters:
site
- The site name.env
- The environment name.domain
- The domain name.
-
Add a domain name.
Parameters:
site
- The site name.env
- The environment name.domain
- The domain name to add.
-
Deploy code from one site environment to another.
Parameters:
site
- The site name.source
- The source environment name.target
- The target environment name.
-
Copy a database from one site environment to another.
Parameters:
site
- The site name.db
- The database name.source
- The source environment name.target
- The target environment name.
-
Move domain(s) from one site environment to another.
Parameters:
site
- The site name.source
- The source environment name.target
- The target environment name.
-
Deploy a specific VCS branch or tag to an environment.
Parameters:
site
- The site name.env
- The environment name.
-
Copy files from one site environment to another.
Parameters:
site
- The site name.source
- The source environment name.target
- The target environment name.
-
Delete a database.
Parameters:
site
- The site name.db
- The database name.
-
Delete a site environment database instance backup.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.backup
- The backup id.
-
List a site's databases.
Parameters:
site
- The site name.
-
Get a database record.
Parameters:
site
- The site name.db
- The database name.
-
List a site environment's database instances.
Parameters:
site
- The site name.env
- The environment name.
-
Get a database instance.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.
-
List a site environment's database instance backups.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.
-
Get details about a database instance backup.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.backup
- The backup id.
-
Download a database instance backup from server.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.backup
- The backup id.
-
Add a database.
Parameters:
site
- The site name.
-
Create a database instance backup.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.
-
Restore a site environment database instance backup.
Parameters:
site
- The site name.env
- The environment name.db
- The database name.backup
- The backup id.
-
List all sites accessible by the caller.
-
Get a site record.
Parameters:
site
- The site name.
-
Get an environment record.
Parameters:
site
- The site name.
-
Get an environment record.
Parameters:
site
- The site name.env
- The environment name.
-
Retrieve an authenticated command to stream log files for an environment.
Parameters:
site
- The site name.env
- The environment name.
-
Install a Drupal distro or Drush Make file into an environment.
Parameters:
site
- The site name.env
- The environment name.type
- Thedistro_url
ormake_url
.
-
Configure Live Development on an environment.
Parameters:
site
- The site name.env
- The environment name.action
- Valid options areenable
ordisable
.