Information for: DEVELOPERS   PARTNERS   SUPPORT

Acquia CLI commands

Acquia CLI command list and help

Use the following commands to view a list of the available commands, and the help for each command.

  • Run acli or acli list to view a list of all available commands and their description.

  • Run acli api or acli api:list to view the commands that you can use to access the 200+ Cloud Platform API endpoints accessible from Acquia CLI.

  • Run acli help <command> or acli [command] --help to view additional information such as usage and options for a specific command.

    For example, if you run acli help ssh-key:create, you will get:

    Description:
      Create an SSH key on your local machine
    
    Usage:
      ssh-key:create [options]
    
    Options:
          --filename=FILENAME  The filename of the SSH key
          --password=PASSWORD  The password for the SSH key
      -h, --help               Display this help message
      -q, --quiet              Do not output any message
      -V, --version            Display this application version
          --ansi               Force ANSI output
          --no-ansi            Disable ANSI output
      -n, --no-interaction     Do not ask any interactive question
      -v|vv|vvv, --verbose     Increase the verbosity of messages: 1 for
                               normal
                               output, 2 for more verbose output and 3 for
                               debug
    

acsf

api

Commands

Global

help

Display help for a command

Usage
  • help [--format FORMAT] [--raw] [--] [<command_name>]

The help command displays help for a given command:

/Users/aurelien.navarre/Git/acquia/cli/bin/acli help list

You can also output the help in other formats by using the –format option:

/Users/aurelien.navarre/Git/acquia/cli/bin/acli help –format=xml list

To display the list of available commands, please use the list command.

Arguments
command_name

The command name

  • Is required: no
  • Is array: no
  • Default: 'help'
Options
–format

The output format (txt, xml, json, or md)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: 'txt'
–raw

To output raw command help

  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false

docs

Open Acquia product documentation in a web browser

Usage
  • docs [<product>]
  • docs acli

Open Acquia product documentation in a web browser

Arguments
product

Acquia Product Name

  • Is required: no
  • Is array: no
  • Default: NULL

acsf

acsf:list

List all Acquia Cloud Site Factory commands

Usage
  • acsf:list
  • acsf

List all Acquia Cloud Site Factory commands

acsf:api:regenerate-all-keys

Regenerate ALL users API keys

Usage
  • acsf:api:regenerate-all-keys

For more help, see https://cloudapi-docs.acquia.com/

acsf:api:regenerate-key

Regenerate a user’s API key

Usage
  • acsf:api:regenerate-key <user_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
user_id

The user ID of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:info:audit-events-find

List audit events

Usage
  • acsf:info:audit-events-find [--limit LIMIT] [--page PAGE] [--order ORDER] [--source SOURCE] [--module MODULE] [--scope SCOPE] [--type TYPE] [--nid NID] [--uid UID]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 100).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–order

Either “ASC” or “DESC”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–source

The source of the event.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–module

The system name of the module.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–scope

The general scope of the changes.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–type

The specific type of changes.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–nid

An associated node ID.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–uid

The user who made the change.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:roles:get-mgr

Get current centralized role management settings.

Usage
  • acsf:roles:get-mgr

For more help, see https://cloudapi-docs.acquia.com/

acsf:roles:set-mgr

Set the centralized role management settings for a given role.

Usage
  • acsf:roles:set-mgr <factory_role> <site_role>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
factory_role

The site factory role. Currently the only supported ones are “content_editor”, “platform_admin” and “site_builder”.

  • Is required: yes
  • Is array: no
  • Default: NULL
site_role

The corresponding role on the site.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:roles:disable-mgr

Disable the centralized role management settings for a given role.

Usage
  • acsf:roles:disable-mgr <factory_role>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
factory_role

The site factory role. Currently the only supported ones are “content_editor”, “platform_admin” and “site_builder”.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:info:stacks-find

Get list of available stacks.

Usage
  • acsf:info:stacks-find

For more help, see https://cloudapi-docs.acquia.com/

acsf:crons:create

Create a new cron job.

Usage
  • acsf:crons:create <name> <cron_command> <interval> <sites_affected> <enabled> <thread_percentage> <stacks>...

For more help, see https://cloudapi-docs.acquia.com/

Arguments
name

The cron job name.

  • Is required: yes
  • Is array: no
  • Default: NULL
cron_command

The command that should be executed.

  • Is required: yes
  • Is array: no
  • Default: NULL
interval

A unix cron expression.

  • Is required: yes
  • Is array: no
  • Default: NULL
sites_affected

Possible values: dev-sites - sites without custom domains, prod-sites - sites with custom domains, all

  • Is required: yes
  • Is array: no
  • Default: NULL
enabled

If the cron should be enabled.

  • Is required: yes
  • Is array: no
  • Default: NULL
thread_percentage

The percentage of cron threads that should be used for this cron. Value has to be an integer between 0 and 100.

  • Is required: yes
  • Is array: no
  • Default: NULL
stacks

An array of stack ids for which the cron should be enabled.

  • Is required: yes
  • Is array: yes
  • Default: array ()

acsf:cron:find-jobs

Get cron jobs. sites_affected: dev-sites(without custom domains)|prod-sites(with custom domains)|all

Usage
  • acsf:cron:find-jobs [--limit LIMIT] [--page PAGE]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 1000).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:crons:edit

Edit a cron job.

Usage
  • acsf:crons:edit <job_id> <name> <cron_command> <interval> <sites_affected> <enabled> <thread_percentage> <stacks>...

For more help, see https://cloudapi-docs.acquia.com/

Arguments
job_id

Cron job id.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The cron job name.

  • Is required: yes
  • Is array: no
  • Default: NULL
cron_command

The command that should be executed.

  • Is required: yes
  • Is array: no
  • Default: NULL
interval

A unix cron expression.

  • Is required: yes
  • Is array: no
  • Default: NULL
sites_affected

Possible values: dev-sites - sites without custom domains, prod-sites - sites with custom domains, all

  • Is required: yes
  • Is array: no
  • Default: NULL
enabled

If the cron should be enabled.

  • Is required: yes
  • Is array: no
  • Default: NULL
thread_percentage

The percentage of cron threads that should be used for this cron. Value has to be an integer between 0 and 100.

  • Is required: yes
  • Is array: no
  • Default: NULL
stacks

An array of stack ids for which the cron should be enabled.

  • Is required: yes
  • Is array: yes
  • Default: array ()

acsf:crons:delete

Delete a cron job.

Usage
  • acsf:crons:delete <job_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
job_id

Cron job id.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:cron:get-job

Get cron job

Usage
  • acsf:cron:get-job <job_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
job_id

Cron job id

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:domains:get

Get domains

Usage
  • acsf:domains:get <node_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
node_id

Site node id.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:domains:get-status

Get domain status

Usage
  • acsf:domains:get-status <domain_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
domain_name

The domain name.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:domains:add

Add domain

Usage
  • acsf:domains:add <node_id> <domain_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
node_id

Site node id.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain_name

The domain name to add.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:domains:remove

Remove domain

Usage
  • acsf:domains:remove <node_id> <domain_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
node_id

Site node id.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain_name

The domain name to remove.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:domains:backfill-std

Backfill the current factory standard domain templates.

Usage
  • acsf:domains:backfill-std

For more help, see https://cloudapi-docs.acquia.com/

acsf:domains:get-std-templates

Get the current factory standard domain templates.

Usage
  • acsf:domains:get-std-templates

For more help, see https://cloudapi-docs.acquia.com/

acsf:domains:set-std-templates

Set the factory standard domain template.

Usage
  • acsf:domains:set-std-templates <template_name> <new_template>...

For more help, see https://cloudapi-docs.acquia.com/

Arguments
template_name

The template name to change. Currently the only supported ones are “site_prod”, “site_nonprod”, “collection_prod” and “collection_nonprod”.

  • Is required: yes
  • Is array: no
  • Default: NULL
new_template

The new template.

  • Is required: yes
  • Is array: yes
  • Default: array ()

acsf:domains:remove-std-templates

Remove the factory standard domain template.

Usage
  • acsf:domains:remove-std-templates <template_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
template_name

The template name to remove. Currently the only supported ones are “site_prod”, “site_nonprod”, “collection_prod” and “collection_nonprod”.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:find-members

List group members

Usage
  • acsf:groups:find-members [--limit LIMIT] [--page PAGE] [--] <group_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–limit

A positive integer (max 1000).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:groups:add-members

Add members to a group

Usage
  • acsf:groups:add-members <group_id> <uids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
uids

A single user ID, or an array of user IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:remove-members

Remove members from a group

Usage
  • acsf:groups:remove-members <group_id> <uids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
uids

A single user ID, or an array of user IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:get

Get a group

Usage
  • acsf:groups:get <group_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:delete

Delete a group

Usage
  • acsf:groups:delete <group_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:find

List groups

Usage
  • acsf:groups:find [--limit LIMIT] [--page PAGE]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer not higher than 100.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:groups:create

Create a group

Usage
  • acsf:groups:create [--parent_id PARENT_ID] [--] <group_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_name

The name of the site group to create.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–parent_id

The parent group ID, if applicable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:groups:edit

Edit a group

Usage
  • acsf:groups:edit <group_id> <group_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group ID.

  • Is required: yes
  • Is array: no
  • Default: NULL
group_name

New name for the group.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:make-members-admins

Make members group admin

Usage
  • acsf:groups:make-members-admins <group_id> <uids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
uids

A single user ID, or an array of user IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:remove-admins

Remove group admin from members

Usage
  • acsf:groups:remove-admins <group_id> <uids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
uids

A single user ID, or an array of user IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:add-sites

Add site(s) to a site group.

Usage
  • acsf:groups:add-sites <group_id> <site_ids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
site_ids

Either a single site ID, or an array of site IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:remove-sites

Remove site(s) from a site group.

Usage
  • acsf:groups:remove-sites <group_id> <site_ids>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
site_ids

Either a single site ID, or an array of site IDs.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:groups:find-sites

List sites in a group.

Usage
  • acsf:groups:find-sites [--limit LIMIT] [--page PAGE] [--] <group_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
group_id

Group id.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–limit

A positive integer (max 1000).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:install-profiles:find

List installation profiles.

Usage
  • acsf:install-profiles:find [--stack_id STACK_ID] [--is_enabled IS_ENABLED]

For more help, see https://cloudapi-docs.acquia.com/

Options
–stack_id

Get only the profiles on the given stack.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–is_enabled

Get only the enabled/disabled profiles.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:install-profiles:enable

Enable installation profile.

Usage
  • acsf:install-profiles:enable [--stack_id STACK_ID] [--] <profile_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
profile_name

The installation profile name.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–stack_id

The installation profile’s stack.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:install-profiles:disable

Disable installation profile.

Usage
  • acsf:install-profiles:disable [--stack_id STACK_ID] [--] <profile_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
profile_name

The installation profile name.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–stack_id

The installation profile’s stack.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:install-profiles:set-default

Sets the installation profile as default.

Usage
  • acsf:install-profiles:set-default [--stack_id STACK_ID] [--] <profile_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
profile_name

The installation profile name.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–stack_id

The installation profile’s stack.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:page-views:aggregated

List monthly aggregated dynamic request statistics.

Usage
  • acsf:page-views:aggregated [--start_from START_FROM] [--sort_order SORT_ORDER] [--limit LIMIT] [--page PAGE] [--] <stack_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
stack_id

The stack id for which to fetch the dynamic request statistics. If there is only one stack, this parameter can be omitted.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–start_from

The first date from which to start showing the statistics in the format of YYYY-MM.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort_order

The sort order direction. Either asc or desc.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The number of months to be listed. Maximum value is 120.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

The page number to show in the list.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:page-views:by-domain

List monthly dynamic request statistics by domain.

Usage
  • acsf:page-views:by-domain [--domain_name DOMAIN_NAME] [--sort_order SORT_ORDER] [--limit LIMIT] [--page PAGE] [--] <stack_id> <date>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
stack_id

The stack id for which to fetch the dynamic request statistics. If there is only one stack, this parameter can be omitted.

  • Is required: yes
  • Is array: no
  • Default: NULL
date

The month in the format of YYYY-MM.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–domain_name

Full domain name or a prefix for filtering the results.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort_order

The sort order direction. Either asc or desc.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The number of domains to be listed. (max 100)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

The page number to show in the list.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:pause-all

Pause/resume task processing

Usage
  • acsf:tasks:pause-all [--reason REASON] [--] <paused>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
paused

Pauses/resumes the WIP task processing.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–reason

Brief explanation for pausing workers.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:pause

Pause/resume task processing for a specific task

Usage
  • acsf:tasks:pause [--level LEVEL] [--] <task_id> <paused>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
task_id

TaskID.

  • Is required: yes
  • Is array: no
  • Default: NULL
paused

Leave the task in paused or unpaused state.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–level

Pause/unpause just the specified task or all its children (task|family).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:api:ping

Check service response

Usage
  • acsf:api:ping

For more help, see https://cloudapi-docs.acquia.com/

acsf:roles:find

List roles

Usage
  • acsf:roles:find [--limit LIMIT] [--page PAGE] [--order ORDER]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 100).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–order

Either “ASC” or “DESC”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:roles:create

Create a role

Usage
  • acsf:roles:create <name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
name

The name of the role.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:roles:get

Retrieve a role

Usage
  • acsf:roles:get <role_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
role_id

The role ID of the user role.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:roles:delete

Delete a role

Usage
  • acsf:roles:delete <role_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
role_id

The role ID of the user role.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:roles:update

Update (rename) a role

Usage
  • acsf:roles:update <role_id> <new_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
role_id

The role ID of the user role.

  • Is required: yes
  • Is array: no
  • Default: NULL
new_name

The new name for the user role.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:api:factory-version

Get the version of the Site Factory

Usage
  • acsf:api:factory-version

For more help, see https://cloudapi-docs.acquia.com/

acsf:site-owner:get

Get current site ownership settings.

Usage
  • acsf:site-owner:get

For more help, see https://cloudapi-docs.acquia.com/

acsf:site-owner:set

Set the site ownership settings.

Usage
  • acsf:site-owner:set <username>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
username

The default owner username. The user has to have the “Platform admin” role.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:site-owner:delete

Delete the site ownership settings.

Usage
  • acsf:site-owner:delete

For more help, see https://cloudapi-docs.acquia.com/

acsf:sites:find

List sites

Usage
  • acsf:sites:find [--limit LIMIT] [--page PAGE] [--canary CANARY] [--show_incomplete SHOW_INCOMPLETE] [--stack_id STACK_ID] [--domain_contains DOMAIN_CONTAINS] [--domain_not_contains DOMAIN_NOT_CONTAINS] [--has_custom_domain HAS_CUSTOM_DOMAIN] [--site_owner SITE_OWNER] [--show_custom_domain SHOW_CUSTOM_DOMAIN]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 1000).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–canary

No value necessary.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–show_incomplete

Show sites that are incomplete.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–stack_id

Show sites on a specific stack.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–domain_contains

Show sites whose domain contains this value.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–domain_not_contains

Show sites whose domain does not contain this value.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–has_custom_domain

Whether to only show sites with custom domains.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–site_owner

Either a user id or a comma separated list of user ids.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–show_custom_domain

Return the first custom domain if the site has one instead of the internal one.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:sites:create

Create a site

Usage
  • acsf:sites:create [--install_profile INSTALL_PROFILE] [--stack_id STACK_ID] [--group_ids GROUP_IDS] [--] <site_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_name

The new site name.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–install_profile

The install profile to be used to install the site.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–stack_id

The stack id where the site should go.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–group_ids

Either a single group ID, or an array of group IDs.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

acsf:sites:get

Site details

Usage
  • acsf:sites:get <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:sites:delete

Site delete

Usage
  • acsf:sites:delete <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:sites:duplicate

Duplicate a site

Usage
  • acsf:sites:duplicate [--exact_copy EXACT_COPY] [--group_ids GROUP_IDS] [--] <site_id> <site_name>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
site_name

The new site name.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–exact_copy

A boolean indicating whether or not to create an exact copy.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–group_ids

Either a single group ID, or an array of group IDs.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

acsf:sites:backup

Create a site backup

Usage
  • acsf:sites:backup [--label LABEL] [--callback_url CALLBACK_URL] [--callback_method CALLBACK_METHOD] [--caller_data CALLER_DATA] [--components COMPONENTS] [--] <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–label

The human-readable description of this backup.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–callback_url

The callback URL, which is invoked upon completion.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–callback_method

The callback method, “GET”, or “POST”. Uses “POST” if empty.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–caller_data

Data that should be included in the callback, json encoded.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–components

Array of components to be included in the backup. The following component names are accepted: codebase, database, public files, private files, themes. When omitting this parameter it will default to a backup with every component.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

acsf:sites:find-backups

List site backups

Usage
  • acsf:sites:find-backups [--limit LIMIT] [--page PAGE] [--] <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–limit

A positive integer (max 100).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:sites:backup-url

Get a temporary site backup URL

Usage
  • acsf:sites:backup-url [--lifetime LIFETIME] [--] <site_id> <backup_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
backup_id

Backup ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–lifetime

The number of seconds the temporary URL is good for.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:sites:delete-backup

Delete a site backup

Usage
  • acsf:sites:delete-backup [--callback_url CALLBACK_URL] [--callback_method CALLBACK_METHOD] [--caller_data CALLER_DATA] [--] <site_id> <backup_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
backup_id

Backup ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–callback_url

The callback URL, which is invoked upon completion.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–callback_method

The callback method, “GET”, or “POST”. Uses “POST” if empty.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–caller_data

Data that should be included in the callback, json encoded.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:sites:restore-backup

Restore a site backup

Usage
  • acsf:sites:restore-backup [--target_site_id TARGET_SITE_ID] [--backup_id BACKUP_ID] [--callback_url CALLBACK_URL] [--callback_method CALLBACK_METHOD] [--caller_data CALLER_DATA] [--components COMPONENTS] [--] <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–target_site_id

ID of the site to restore the backup onto.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–backup_id

ID of the backup to restore defaults to the most recent.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–callback_url

The callback URL, which is invoked upon completion.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–callback_method

The callback method, “GET”, or “POST”. Uses “POST” if empty.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–caller_data

Data that should be included in the callback, json encoded.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–components

Array of components to be restored from the backup. The following component names are accepted: database, public files, private files, themes. When omitting this parameter it will default to the backup’s every component.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

acsf:sites:clear-cache

Clear a site’s caches

Usage
  • acsf:sites:clear-cache <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:stage-v2:find-envs

Retrieve available environments

Usage
  • acsf:stage-v2:find-envs

For more help, see https://cloudapi-docs.acquia.com/

acsf:stage-v2:start

Start staging process

Usage
  • acsf:stage-v2:start [--wipe_target_environment WIPE_TARGET_ENVIRONMENT] [--synchronize_all_users SYNCHRONIZE_ALL_USERS] [--detailed_status DETAILED_STATUS] [--skip_site_files SKIP_SITE_FILES] [--sites SITES] [--wipe_stacks WIPE_STACKS] [--skip_site_files_overwrite SKIP_SITE_FILES_OVERWRITE] [--] <to_env>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
to_env

Environment to deploy to.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–wipe_target_environment

Use this option to wipe the management console and all stacks on the selected environment before deploying sites.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–synchronize_all_users

Use this parameter to only stage the user accounts that are required for the provided sites and the related site collections and site groups.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–detailed_status

Provide a status email for each site as it completes.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–skip_site_files

Skip copying the staged down sites’ files.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sites

Node IDs of sites to deploy.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()
–wipe_stacks

Stack ids to wipe. It will be ignored if wipe_target_environment is true.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()
–skip_site_files_overwrite

File patterns to skip copying during the stage down process. Ignored if skip_site_files is false.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

acsf:service-status:get

Get service status information

Usage
  • acsf:service-status:get

For more help, see https://cloudapi-docs.acquia.com/

acsf:service-status:modify

Modify service status

Usage
  • acsf:service-status:modify [--all ALL] [--site_creation SITE_CREATION] [--site_duplication SITE_DUPLICATION] [--domain_management DOMAIN_MANAGEMENT] [--bulk_operations BULK_OPERATIONS]

For more help, see https://cloudapi-docs.acquia.com/

Options
–all

on, off, or something strtotime accepts

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–site_creation

on, off, or something strtotime accepts

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–site_duplication

on, off, or something strtotime accepts

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–domain_management

on, off, or something strtotime accepts

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–bulk_operations

on, off, or something strtotime accepts

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:find-wip-classes

(Internal use only) Get Task class information.

Usage
  • acsf:tasks:find-wip-classes <type>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
type

Either “softpaused” or “softpause-for-update”

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:tasks:get

(Internal use only) Get Task information.

Usage
  • acsf:tasks:get [--limit LIMIT] [--page PAGE] [--status STATUS] [--class CLASS] [--group GROUP]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 100).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–status

processing, error or not-started

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–class

A WIP class name to filter on.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–group

A WIP group name to filter on.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:log

(Internal use only) Get Task log information.

Usage
  • acsf:tasks:log [--level LEVEL] [--descendants DESCENDANTS] [--] <task_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
task_id

Task ID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–level

The minimum status level to display

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–descendants

Include the logs of all descendant tasks.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:delete

Delete tasks from the work pool.

Usage
  • acsf:tasks:delete <task_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
task_id

Task ID.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:tasks:terminate

Terminate tasks in the work pool.

Usage
  • acsf:tasks:terminate <task_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
task_id

Task ID.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:tasks:get-task-log-settings

Get current task log settings.

Usage
  • acsf:tasks:get-task-log-settings

For more help, see https://cloudapi-docs.acquia.com/

acsf:tasks:set-task-log-settings

Edit current task log settings.

Usage
  • acsf:tasks:set-task-log-settings [--wip_log_level WIP_LOG_LEVEL] [--wip_log_maximum_level WIP_LOG_MAXIMUM_LEVEL]

For more help, see https://cloudapi-docs.acquia.com/

Options
–wip_log_level

Level of Wip log messages to keep on successful completion.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–wip_log_maximum_level

The maximum log level that will be written to the log.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:reset-task-log-settings

Reset task log settings.

Usage
  • acsf:tasks:reset-task-log-settings

For more help, see https://cloudapi-docs.acquia.com/

acsf:themes:key

External theme repository deploy key

Usage
  • acsf:themes:key

For more help, see https://cloudapi-docs.acquia.com/

acsf:themes:process-notifications

Process theme modifications

Usage
  • acsf:themes:process-notifications [--sitegroup_id SITEGROUP_ID]

For more help, see https://cloudapi-docs.acquia.com/

Options
–sitegroup_id

The ID of a specific sitegroup to process e.g. “tangle001”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:themes:refresh

Site external theme refresh

Usage
  • acsf:themes:refresh <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:themes:send-notification

Send a theme notification

Usage
  • acsf:themes:send-notification [--nid NID] [--theme THEME] [--uid UID] [--] <scope> <event>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
scope

The scope. Either “theme”, “site”, “group”, or “global”.

  • Is required: yes
  • Is array: no
  • Default: NULL
event

The type of theme event. Either “create”, “modify”, or “delete”.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–nid

The node ID of the related entity (site or group). Not relevant for the “global” scope.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–theme

The system name of the theme. Only relevant for “theme” scope notifications.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–uid

The user id owning the notification and who should get notified if an error occurs during processing.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:site-owner:transfer

Transfer the site ownership.

Usage
  • acsf:site-owner:transfer [--username USERNAME] [--email EMAIL] [--force_transfer FORCE_TRANSFER] [--] <site_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
site_id

Site ID

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–username

New owner username to which site needs to be transferred (either username or email field is required).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–email

New owner email id to which site needs to be transferred.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–force_transfer

Transfer site ownership without mail confirmation from owner and recipient.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:updates:start

Start an update

Usage
  • acsf:updates:start [--scope SCOPE] [--start_time START_TIME] [--sites_ref SITES_REF] [--factory_ref FACTORY_REF] [--sites_type SITES_TYPE] [--factory_type FACTORY_TYPE] [--stack_id STACK_ID] [--site_update_fail_action SITE_UPDATE_FAIL_ACTION] [--db_update_arguments DB_UPDATE_ARGUMENTS]

For more help, see https://cloudapi-docs.acquia.com/

Options
–scope

Either “sites”, “factory”, or “both”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–start_time

A start time string, parseable by strtotime(). Interpreted as UTC if no timezone is specified.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sites_ref

A VCS ref to deploy to the sites.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–factory_ref

A VCS ref to deploy to the Factory.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sites_type

Either “code”, “code, db”, or “code, db, registry”

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–factory_type

Either “code” or “code, db”

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–stack_id

The stack id to release to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–site_update_fail_action

Action to be performed on sites when updates fail. Either “online” or “offline”

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–db_update_arguments

Custom arguments to supply to the db-update hooks. Space separated alphanumeric characters only.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:updates:find

List updates

Usage
  • acsf:updates:find

For more help, see https://cloudapi-docs.acquia.com/

acsf:updates:status

Get update progress

Usage
  • acsf:updates:status <update_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
update_id

Either int value or ‘last’.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:updates:pause

Pause an update

Usage
  • acsf:updates:pause <pause>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
pause

leave the task in paused or unpaused state.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:users:find

List users

Usage
  • acsf:users:find [--limit LIMIT] [--page PAGE] [--order ORDER] [--ids IDS] [--role_ids ROLE_IDS] [--status STATUS] [--uid_min UID_MIN] [--uid_max UID_MAX] [--created_min CREATED_MIN] [--created_max CREATED_MAX] [--login_min LOGIN_MIN] [--login_max LOGIN_MAX] [--tfa_status TFA_STATUS] [--fields FIELDS]

For more help, see https://cloudapi-docs.acquia.com/

Options
–limit

A positive integer (max 100).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–page

A positive integer.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–order

Either “ASC” or “DESC”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–ids

A comma-separated list of user IDs.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–role_ids

A comma-separated list of role IDs.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–status

Either “active” or “blocked”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–uid_min

First uid value to start with.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–uid_max

Last uid value to fetch.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–created_min

Lowest ‘created’ value (timestamp).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–created_max

Highest ‘created’ value (timestamp).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–login_min

Lowest ‘login’ value (timestamp).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–login_max

Highest ‘login’ value (timestamp).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–tfa_status

Either “active” or “disabled”.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–fields

A comma-separated list of Drupal user fields.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:users:create

Create a user

Usage
  • acsf:users:create [--pass PASS] [--status STATUS] [--roles ROLES] [--] <name> <mail>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
name

The name of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL
mail

The email address of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–pass

The user’s password. (Included in the response, if not provided.)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–status

The user’s status, either 0 or 1.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–roles

Either a single role name, or an array of role names.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:users:get

Retrieve a user

Usage
  • acsf:users:get [--fields FIELDS] [--] <user_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
user_id

The user ID of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–fields

A comma-separated list of fields to retrieve.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:users:delete

Delete a user

Usage
  • acsf:users:delete <user_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
user_id

The user ID of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:users:update

Update a user

Usage
  • acsf:users:update [--name NAME] [--mail MAIL] [--pass PASS] [--status STATUS] [--roles ROLES] [--tfa_status TFA_STATUS] [--] <user_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
user_id

The user ID of the user.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The name of the user.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–mail

The email address of the user.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–pass

The user’s password.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–status

The user’s status, either 0 or 1.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–roles

Single role name, or an array of them.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–tfa_status

The user’s TFA status, either 0 or 1.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:info:vcs-find

List deployable refs

Usage
  • acsf:info:vcs-find [--stack_id STACK_ID] [--] <type>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
type

Either “sites” or “factory”. (Note: “factory” is restricted to Acquia employees.)

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–stack_id

The stack id.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

acsf:tasks:status

Wip task status

Usage
  • acsf:tasks:status <task_id>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
task_id

The Wip task ID

  • Is required: yes
  • Is array: no
  • Default: NULL

acsf:api

List all API commands for the api resource

Usage
  • acsf:api

List all API commands for the api resource

acsf:info

List all API commands for the info resource

Usage
  • acsf:info

List all API commands for the info resource

acsf:roles

List all API commands for the roles resource

Usage
  • acsf:roles

List all API commands for the roles resource

acsf:crons

List all API commands for the crons resource

Usage
  • acsf:crons

List all API commands for the crons resource

acsf:cron

List all API commands for the cron resource

Usage
  • acsf:cron

List all API commands for the cron resource

acsf:domains

List all API commands for the domains resource

Usage
  • acsf:domains

List all API commands for the domains resource

acsf:groups

List all API commands for the groups resource

Usage
  • acsf:groups

List all API commands for the groups resource

acsf:install-profiles

List all API commands for the install-profiles resource

Usage
  • acsf:install-profiles

List all API commands for the install-profiles resource

acsf:page-views

List all API commands for the page-views resource

Usage
  • acsf:page-views

List all API commands for the page-views resource

acsf:tasks

List all API commands for the tasks resource

Usage
  • acsf:tasks

List all API commands for the tasks resource

acsf:site-owner

List all API commands for the site-owner resource

Usage
  • acsf:site-owner

List all API commands for the site-owner resource

acsf:sites

List all API commands for the sites resource

Usage
  • acsf:sites

List all API commands for the sites resource

acsf:stage-v2

List all API commands for the stage-v2 resource

Usage
  • acsf:stage-v2

List all API commands for the stage-v2 resource

acsf:service-status

List all API commands for the service-status resource

Usage
  • acsf:service-status

List all API commands for the service-status resource

acsf:themes

List all API commands for the themes resource

Usage
  • acsf:themes

List all API commands for the themes resource

acsf:updates

List all API commands for the updates resource

Usage
  • acsf:updates

List all API commands for the updates resource

acsf:users

List all API commands for the users resource

Usage
  • acsf:users

List all API commands for the users resource

api

api:list

List all API commands

Usage
  • api:list
  • api

List all API commands

api:system-health-status

Return the current system health status.

Usage
  • api:system-health-status

For more help, see https://cloudapi-docs.acquia.com/

api:accounts:find

Returns details about your account.

Usage
  • api:accounts:find

For more help, see https://cloudapi-docs.acquia.com/

api:accounts:application-has-permission

Returns whether your account has access to a specific application permission.

Usage
  • api:accounts:application-has-permission <applicationUuid> <permission>
  • api:accounts:application-has-permission da1c0a8e-ff69-45db-88fc-acd6d2affbb7 "deploy to prod"
  • api:accounts:application-has-permission myapp "deploy to prod"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
permission

Specifies the permission you wish to check access for.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-application-admin

Returns whether your account is an administrator for an application.

Usage
  • api:accounts:is-application-admin <applicationUuid>
  • api:accounts:is-application-admin da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:accounts:is-application-admin myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-application-owner

Returns whether your account is the owner for an application.

Usage
  • api:accounts:is-application-owner <applicationUuid>
  • api:accounts:is-application-owner da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:accounts:is-application-owner myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:application-mark-recent

Marks an application as recently viewed.

Usage
  • api:accounts:application-mark-recent <applicationUuid>
  • api:accounts:application-mark-recent da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:accounts:application-mark-recent myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:application-star

Stars an application.

Usage
  • api:accounts:application-star <applicationUuid>
  • api:accounts:application-star da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:accounts:application-star myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:application-unstar

Removes an application from the user’s starred list.

Usage
  • api:accounts:application-unstar <applicationUuid>
  • api:accounts:application-unstar da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:accounts:application-unstar myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:ide-list

Returns a list of Cloud IDEs associated with the current user.

Usage
  • api:accounts:ide-list

For more help, see https://cloudapi-docs.acquia.com/

api:accounts:invites-list

Gets a list of all organization admin and team invites that are pending for the current user.

Usage
  • api:accounts:invites-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:accounts:invites-list --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:accounts:messages-list

Returns a list of messages associated with the current user.

Usage
  • api:accounts:messages-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:accounts:messages-list --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:accounts:is-organization-admin

Returns whether your account is an administrator for an organization.

Usage
  • api:accounts:is-organization-admin <organizationUuid>
  • api:accounts:is-organization-admin 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-organization-owner

Returns whether your account is the owner for an organization.

Usage
  • api:accounts:is-organization-owner <organizationUuid>
  • api:accounts:is-organization-owner 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:password-check

Verifies that the supplied password matches the current user’s password.

Usage
  • api:accounts:password-check <password>
  • api:accounts:password-check "mysupersecretpassword"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
password

The password to verify.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:ssh-keys-list

Gets a list of SSH keys associated with the current user.

Usage
  • api:accounts:ssh-keys-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:accounts:ssh-keys-list --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:accounts:ssh-key-create

Installs a new SSH key for the current user.

Usage
  • api:accounts:ssh-key-create <label> <public_key>
  • api:accounts:ssh-key-create "mykey" "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQChwPHzTTDKDpSbpa2+d22LcbQmsw92eLsUK3Fmei1fiGDkd34NsYCN8m7lsi3NbvdMS83CtPQPWiCveYPzFs1/hHc4PYj8opD2CNnr5iWVVbyaulCYHCgVv4aB/ojcexg8q483A4xJeF15TiCr/gu34rK6ucTvC/tn/rCwJBudczvEwt0klqYwv8Cl/ytaQboSuem5KgSjO3lMrb6CWtfSNhE43ZOw+UBFBqxIninN868vGMkIv9VY34Pwj54rPn/ItQd6Ef4B0KHHaGmzK0vfP+AK7FxNMoHnj3iYT33KZNqtDozdn5tYyH/bThPebEtgqUn+/w5l6wZIC/8zzvls/127ngHk+jNa0PlNyS2TxhPUK4NaPHIEnnrlp07JEYC4ImcBjaYCWAdcTcUkcJjwZQkN4bGmyO9cjICH98SdLD/HxqzTHeaYDbAX/Hu9HfaBb5dXLWsjw3Xc6hoVnUUZbMQyfgb0KgxDLh92eNGxJkpZiL0VDNOWCxDWsNpzwhLNkLqCvI6lyxiLaUzvJAk6dPaRhExmCbU1lDO2eR0FdSwC1TEhJOT9eDIK1r2hztZKs2oa5FNFfB/IFHVWasVFC9N2h/r/egB5zsRxC9MqBLRBq95NBxaRSFng6ML5WZSw41Qi4C/JWVm89rdj2WqScDHYyAdwyyppWU4T5c9Fmw== example@example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
label

The SSH key label.

  • Is required: yes
  • Is array: no
  • Default: NULL
public_key

The public key.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:ssh-key-find

Get an SSH key associated with the currently-logged in user.

Usage
  • api:accounts:ssh-key-find <sshKeyUuid>
  • api:accounts:ssh-key-find 981b7910-2fe9-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
sshKeyUuid

The SSH key entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:ssh-key-delete

Deletes an SSH key.

Usage
  • api:accounts:ssh-key-delete <sshKeyUuid>
  • api:accounts:ssh-key-delete 981b7910-2fe9-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
sshKeyUuid

The SSH key entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-subscription-admin

Returns whether your account is an administrator for a subscription.

Usage
  • api:accounts:is-subscription-admin <subscriptionUuid>
  • api:accounts:is-subscription-admin 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-subscription-owner

Returns whether your account is the owner for a subscription.

Usage
  • api:accounts:is-subscription-owner <subscriptionUuid>
  • api:accounts:is-subscription-owner 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:has-team-permission

Returns whether your account has access to a specific team permission.

Usage
  • api:accounts:has-team-permission <teamUuid> <permission>
  • api:accounts:has-team-permission 3eef5d81-62f4-429c-aa94-e17d05ab4740 "deploy to prod"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
permission

Specifies the permission you wish to check access for.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-team-admin

Returns whether your account is an administrator for a team.

Usage
  • api:accounts:is-team-admin <teamUuid>
  • api:accounts:is-team-admin 3eef5d81-62f4-429c-aa94-e17d05ab4740

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:is-team-owner

Returns whether your account is the owner for a team.

Usage
  • api:accounts:is-team-owner <teamUuid>
  • api:accounts:is-team-owner 3eef5d81-62f4-429c-aa94-e17d05ab4740

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:tokens-list

Returns a list of metadata for API access tokens tied to your account.

Usage
  • api:accounts:tokens-list

For more help, see https://cloudapi-docs.acquia.com/

api:accounts:token-create

Creates an API access token tied to your account.

Usage
  • api:accounts:token-create <label>
  • api:accounts:token-create "API token for My App"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
label

The label to give to the token for future reference.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:token-list

Return details about a specific token.

Usage
  • api:accounts:token-list <tokenUuid>
  • api:accounts:token-list 882f3258-2fe9-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
tokenUuid

The token entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts:token-delete

Revokes an access token.

Usage
  • api:accounts:token-delete [--tokenDeleteReason TOKENDELETEREASON] [--] <tokenUuid>
  • api:accounts:token-delete 882f3258-2fe9-11e9-b210-d663bd873d93 --tokenDeleteReason="The quick brown fox jumped over the lazy dog."

For more help, see https://cloudapi-docs.acquia.com/

Arguments
tokenUuid

The token entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–tokenDeleteReason

Specifies the reason for the token revocation for future reference.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:agreements:list

Return a list of agreements.

Usage
  • api:agreements:list

For more help, see https://cloudapi-docs.acquia.com/

api:agreements:find

Return a specific agreement by a provided UUID.

Usage
  • api:agreements:find <agreementUuid>
  • api:agreements:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
agreementUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:agreements:accept

Accepts a legal agreement by UUID.

Usage
  • api:agreements:accept <agreementUuid>
  • api:agreements:accept da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
agreementUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:agreements:decline

Declines a legal agreement by UUID.

Usage
  • api:agreements:decline <agreementUuid>
  • api:agreements:decline da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
agreementUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:agreements:invitees-list

Returns a list of users invited to action this agreement.

Usage
  • api:agreements:invitees-list <agreementUuid>
  • api:agreements:invitees-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
agreementUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:list

Return a list of applications the current user has access to.

Usage
  • api:applications:list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:applications:list --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:find

Return details about a specific application.

Usage
  • api:applications:find <applicationUuid>
  • api:applications:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:find myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:rename

Renames an application.

Usage
  • api:applications:rename [--name NAME] [--] <applicationUuid>
  • api:applications:rename da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --name="My new application name"
  • api:applications:rename myapp --name="My new application name"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The new name of the application.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:artifact-list

Return application artifacts.

Usage
  • api:applications:artifact-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:artifact-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:artifact-list myapp --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:artifact-find

Return details about a specific artifact.

Usage
  • api:applications:artifact-find <applicationUuid> <artifactId>
  • api:applications:artifact-find da1c0a8e-ff69-45db-88fc-acd6d2affbb7 drupal8
  • api:applications:artifact-find myapp drupal8

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
artifactId

An ID that uniquely identifies an artifact.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:vcs-info

Return application branches and release tags.

Usage
  • api:applications:vcs-info [--sort SORT] [--filter FILTER] [--] <applicationUuid>
  • api:applications:vcs-info da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2"
  • api:applications:vcs-info myapp --sort="field1,-field2"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:database-list

Returns a list database names for the application.

Usage
  • api:applications:database-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:database-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:database-list myapp --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:database-create

Creates a database.

Usage
  • api:applications:database-create <applicationUuid> <name>
  • api:applications:database-create da1c0a8e-ff69-45db-88fc-acd6d2affbb7 "my_db_name"
  • api:applications:database-create myapp "my_db_name"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The database name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:database-delete

Drops (deletes) a database.

Usage
  • api:applications:database-delete <applicationUuid> <name>
  • api:applications:database-delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7 drupal8
  • api:applications:database-delete myapp drupal8

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

A name that uniquely identifies an entity.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:database-erase

Erases (truncates) a database.

Usage
  • api:applications:database-erase <applicationUuid> <name>
  • api:applications:database-erase da1c0a8e-ff69-45db-88fc-acd6d2affbb7 drupal8
  • api:applications:database-erase myapp drupal8

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

A name that uniquely identifies an entity.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:email-domains-list

Returns a list of email domains associated with the application.

Usage
  • api:applications:email-domains-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:email-domains-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:email-domains-list myapp --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:post-associate-email-domain

Associates an email domain with an Application.

Usage
  • api:applications:post-associate-email-domain <applicationUuid> <domainRegistrationUuid>
  • api:applications:post-associate-email-domain da1c0a8e-ff69-45db-88fc-acd6d2affbb7 da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:post-associate-email-domain myapp da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
domainRegistrationUuid

The Domain Registration universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:post-disassociate-email-domains

Disassociates an email domain with an Application.

Usage
  • api:applications:post-disassociate-email-domains <applicationUuid> <domainRegistrationUuid>
  • api:applications:post-disassociate-email-domains da1c0a8e-ff69-45db-88fc-acd6d2affbb7 da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:post-disassociate-email-domains myapp da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
domainRegistrationUuid

The Domain Registration universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:ide-list

Returns a list of Cloud IDEs associated with this application.

Usage
  • api:applications:ide-list <applicationUuid>
  • api:applications:ide-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:ide-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:message-list

Returns a list of messages associated with this application.

Usage
  • api:applications:message-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:message-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:message-list myapp --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:notification-list

Returns a list of notifications associated with this application by its UUID.

Usage
  • api:applications:notification-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:notification-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:notification-list myapp --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:permission-list

Returns a list of permissions the user has for this application by its UUID.

Usage
  • api:applications:permission-list <applicationUuid>
  • api:applications:permission-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:permission-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:search:list

Returns a traversal endpoint for search entities for the application.

Usage
  • api:applications:search:list <applicationUuid>
  • api:applications:search:list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:search:list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:search:configuration-set-list

Returns a collection of search configuration sets for an application

Usage
  • api:applications:search:configuration-set-list <applicationUuid>
  • api:applications:search:configuration-set-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:search:configuration-set-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:search:configuration-set-create

Creates a search configuration set for an application.

Usage
  • api:applications:search:configuration-set-create <applicationUuid> <archive>
  • api:applications:search:configuration-set-create da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:search:configuration-set-create myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
archive

A binary file response

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:search:configuration-set-find

Returns a search configuration set for an application

Usage
  • api:applications:search:configuration-set-find <applicationUuid> <configurationSetId>
  • api:applications:search:configuration-set-find da1c0a8e-ff69-45db-88fc-acd6d2affbb7 ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
  • api:applications:search:configuration-set-find myapp ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
configurationSetId

An ID that uniquely identifies a configuration set.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:search:configuration-set-delete

Removes and deletes a specific search configuration set from an application.

Usage
  • api:applications:search:configuration-set-delete <applicationUuid> <configurationSetId>
  • api:applications:search:configuration-set-delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7 ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78
  • api:applications:search:configuration-set-delete myapp ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
configurationSetId

An ID that uniquely identifies a configuration set.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:settings-list

Returns available settings for this application.

Usage
  • api:applications:settings-list <applicationUuid>
  • api:applications:settings-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:settings-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:ra-settings-find

Returns the remote administration settings for this application.

Usage
  • api:applications:ra-settings-find <applicationUuid>
  • api:applications:ra-settings-find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:ra-settings-find myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:ra-settings-update

Modifies the remote administration settings for an application.

Usage
  • api:applications:ra-settings-update [--update_type UPDATE_TYPE] [--pause_until PAUSE_UNTIL] [--deploy_at DEPLOY_AT] [--deploy_environment DEPLOY_ENVIRONMENT] [--source_environment SOURCE_ENVIRONMENT] [--copy_files COPY_FILES] [--copy_database COPY_DATABASE] [--merge_tag MERGE_TAG] [--merge_branch MERGE_BRANCH] [--] <applicationUuid> <update_mode>
  • api:applications:ra-settings-update da1c0a8e-ff69-45db-88fc-acd6d2affbb7 "update" --update_type="core_contrib" --pause_until="2021-10-10 13:00:00" --deploy_at="2020-10-13 13:00:00" --deploy_environment="test" --source_environment="prod" --copy_files="" --copy_database="1" --merge_tag="" --merge_branch="master"
  • api:applications:ra-settings-update myapp "update" --update_type="core_contrib" --pause_until="2021-10-10 13:00:00" --deploy_at="2020-10-13 13:00:00" --deploy_environment="test" --source_environment="prod" --copy_files="" --copy_database="1" --merge_tag="" --merge_branch="master"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
update_mode

The update mode to select.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–update_type

What components to update (core only or core and contrib modules).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–pause_until

What date/time to pause RA updates until (if applicable).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–deploy_at

What date/time to deploy RA updates at (if applicable).

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–deploy_environment

The environment id of the environment to deploy to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–source_environment

The environment id of the environment to use as a starting point for testing.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–copy_files

Whether to copy files from production to testing environment.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–copy_database

Whether to copy database from production to testing environment.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–merge_tag

Whether to automatically merge the approved code into your development branch.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–merge_branch

The development branch into which to merge the update tag.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:tag-list

Returns a list of application tags associated with this application.

Usage
  • api:applications:tag-list <applicationUuid>
  • api:applications:tag-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:tag-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:tags-create

Creates a new application tag.

Usage
  • api:applications:tags-create <applicationUuid> <name> <color>
  • api:applications:tags-create da1c0a8e-ff69-45db-88fc-acd6d2affbb7 "Dev" "green"
  • api:applications:tags-create myapp "Dev" "green"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The label of the application tag.

  • Is required: yes
  • Is array: no
  • Default: NULL
color

The color name of the application tag found via the GET /api/options/colors endpoint.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:tags-delete

Deletes an application tag.

Usage
  • api:applications:tags-delete <applicationUuid> <tagName>
  • api:applications:tags-delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7 green
  • api:applications:tags-delete myapp green

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
tagName

The name of the application tag.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:team-list

Returns a list of teams associated with this application.

Usage
  • api:applications:team-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:team-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:team-list myapp --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:usage-data

Retrieves aggregate usage data for an application, filterable by views or visits and by environment.

Usage
  • api:applications:usage-data [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <applicationUuid>
  • api:applications:usage-data da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"
  • api:applications:usage-data myapp --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:usage-data-by-environment

Retrieves usage data (views or visits) for an application, broken down by environment.

Usage
  • api:applications:usage-data-by-environment [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <applicationUuid>
  • api:applications:usage-data-by-environment da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"
  • api:applications:usage-data-by-environment myapp --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:usage-metric-data

Retrieves aggregate usage metric data (views or visits) for an application..

Usage
  • api:applications:usage-metric-data [--from FROM] [--to TO] [--] <usageMetric> <applicationUuid>
  • api:applications:usage-metric-data viewsda1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"
  • api:applications:usage-metric-data viewsda1c0a8e-ff69-45db-88fc-acd6d2affbb7 myapp --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
usageMetric

A usage data metric type.

  • Is required: yes
  • Is array: no
  • Default: NULL
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:usage-views-data-by-environment

Retrieves views data for an application, broken down by environment.

Usage
  • api:applications:usage-views-data-by-environment [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <applicationUuid>
  • api:applications:usage-views-data-by-environment da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"
  • api:applications:usage-views-data-by-environment myapp --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:usage-visits-data-by-environment

Retrieves visits data for an application, broken down by environment.

Usage
  • api:applications:usage-visits-data-by-environment [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <applicationUuid>
  • api:applications:usage-visits-data-by-environment da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --from="-7d" --to="-1d"
  • api:applications:usage-visits-data-by-environment myapp --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:distributions:list

Return a list of Drupal distributions.

Usage
  • api:distributions:list

For more help, see https://cloudapi-docs.acquia.com/

api:distributions:find

Return details about a specific Drupal distribution.

Usage
  • api:distributions:find <name>
  • api:distributions:find drupal8

For more help, see https://cloudapi-docs.acquia.com/

Arguments
name

A name that uniquely identifies an entity.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:applications:environment-list

Returns a list of environments within this application by its UUID.

Usage
  • api:applications:environment-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <applicationUuid>
  • api:applications:environment-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --sort="field1,-field2" --limit="10" --offset="10"
  • api:applications:environment-list myapp --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:applications:environment-create

Add a new continuous delivery environment to an application by the application UUID.

Usage
  • api:applications:environment-create <applicationUuid> <label> <branch> <databases>...
  • api:applications:environment-create da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:environment-create myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL
label

The new environment label.

  • Is required: yes
  • Is array: no
  • Default: NULL
branch

The name of the branch or tag that the continuous delivery environment will have.

  • Is required: yes
  • Is array: no
  • Default: NULL
databases

An array containing the names of the databases to add to the continuous delivery environment.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:applications:feature-list

Return application features.

Usage
  • api:applications:feature-list <applicationUuid>
  • api:applications:feature-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:applications:feature-list myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:find

Return details about a specific environment.

Usage
  • api:environments:find <environmentId>
  • api:environments:find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:update

Modifies configuration settings for an environment.

Usage
  • api:environments:update [--lang_version LANG_VERSION] [--memory_limit MEMORY_LIMIT] [--opcache OPCACHE] [--apcu APCU] [--interned_strings_buffer INTERNED_STRINGS_BUFFER] [--max_execution_time MAX_EXECUTION_TIME] [--max_post_size MAX_POST_SIZE] [--max_input_vars MAX_INPUT_VARS] [--sendmail_path SENDMAIL_PATH] [--] <environmentId>
  • api:environments:update 12-d314739e-296f-11e9-b210-d663bd873d93 --memory_limit="192" --apcu="8" --max_execution_time="10" --max_post_size="256" --max_input_vars="1000" --sendmail_path="/usr/bin/sendmail"
  • api:environments:update myapp.dev --memory_limit="192" --apcu="8" --max_execution_time="10" --max_post_size="256" --max_input_vars="1000" --sendmail_path="/usr/bin/sendmail"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–lang_version

The PHP or Node version.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–memory_limit

Limits PHP request memory usage in megabytes.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–opcache

This is the total amount of memory available for caching precompiled script bytecode per PHP/FPM process.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–apcu

APCu shared memory size per web server.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–interned_strings_buffer

Sets PHP Opcache key count per server.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–max_execution_time

Limits PHP request time in seconds.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–max_post_size

Sets the PHP limit on POST body size.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–max_input_vars

Limits the number of various request items in PHP.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sendmail_path

Sets the PHP sendmail_path, usually to manage the “From” address or disable mail.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:delete

Deletes a CD environment.

Usage
  • api:environments:delete <environmentId>
  • api:environments:delete 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:delete myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:clear-caches

Clears the caches for one or more domains attached to this environment.

Usage
  • api:environments:clear-caches <environmentId> <domains>...
  • api:environments:clear-caches 12-d314739e-296f-11e9-b210-d663bd873d93 "domain1.example.com" "domain2.example.com"
  • api:environments:clear-caches myapp.dev "domain1.example.com" "domain2.example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
domains

A list of domains to clear the caches for.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:environments:migrate

Create a Migrate Environment using the provided environment as its source.

Usage
  • api:environments:migrate [--config CONFIG] [--] <environmentId> <label>
  • api:environments:migrate 12-d314739e-296f-11e9-b210-d663bd873d93 "Migrate Environment" --config="1"
  • api:environments:migrate myapp.dev "Migrate Environment" --config="1"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
label

The Migrate Environment label.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–config

Indicates whether or not to copy configurations.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:promote

Promote a Migrate Environment.

Usage
  • api:environments:promote <environmentId> <target>
  • api:environments:promote 12-d314739e-296f-11e9-b210-d663bd873d93 "6a534a67-2d89-406d-95c8-efb515342983"
  • api:environments:promote myapp.dev "6a534a67-2d89-406d-95c8-efb515342983"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
target

The UUID of the environment to promote to.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:refresh

Refreshes a Migrate Environment.

Usage
  • api:environments:refresh <environmentId>
  • api:environments:refresh 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:refresh myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:artifact-deploy

Deploys an artifact to this environment.

Usage
  • api:environments:artifact-deploy <environmentId> <artifact_id>
  • api:environments:artifact-deploy 12-d314739e-296f-11e9-b210-d663bd873d93 "123"
  • api:environments:artifact-deploy myapp.dev "123"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
artifact_id

The id of the artifact to deploy.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:runtime-list

Return a list of runtimes.

Usage
  • api:environments:runtime-list <environmentId>
  • api:environments:runtime-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:runtime-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cdn-find

Returns the CDN status for an environment.

Usage
  • api:environments:cdn-find <environmentId>
  • api:environments:cdn-find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cdn-find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cdn-enable

Enables a CDN for an environment.

Usage
  • api:environments:cdn-enable <environmentId>
  • api:environments:cdn-enable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cdn-enable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cdn-disable

Disables a CDN for an environment.

Usage
  • api:environments:cdn-disable <environmentId>
  • api:environments:cdn-disable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cdn-disable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cloud-actions-find

Returns a list of Cloud Actions.

Usage
  • api:environments:cloud-actions-find <environmentId>
  • api:environments:cloud-actions-find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cloud-actions-find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cloud-actions-update

Modifies an existing list of Cloud Actions.

Usage
  • api:environments:cloud-actions-update <environmentId> <cloud-actions>
  • api:environments:cloud-actions-update 12-d314739e-296f-11e9-b210-d663bd873d93 "{"fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70":true,"9440be70-c042-47ae-9134-e85acbbd6edf":false}""
  • api:environments:cloud-actions-update myapp.dev "{"fb4aa87a-8be2-42c6-bdf0-ef9d09a3de70":true,"9440be70-c042-47ae-9134-e85acbbd6edf":false}""

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cloud-actions

Whether this Cloud Action is enabled.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cloud-actions-disable

Disables Cloud Actions.

Usage
  • api:environments:cloud-actions-disable <environmentId>
  • api:environments:cloud-actions-disable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cloud-actions-disable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cloud-actions-enable

Enables Cloud Actions.

Usage
  • api:environments:cloud-actions-enable <environmentId>
  • api:environments:cloud-actions-enable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cloud-actions-enable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cloud-actions-reset

Resets Cloud Actions.

Usage
  • api:environments:cloud-actions-reset <environmentId>
  • api:environments:cloud-actions-reset 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cloud-actions-reset myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:code-deploy

Deploys code to this environment.

Usage
  • api:environments:code-deploy [--message MESSAGE] [--cloud-actions CLOUD-ACTIONS] [--] <environmentId> <source>
  • api:environments:code-deploy 12-d314739e-296f-11e9-b210-d663bd873d93 "14-0c7e79ab-1c4a-424e-8446-76ae8be7e851" --message="Optional commit message"
  • api:environments:code-deploy myapp.dev "14-0c7e79ab-1c4a-424e-8446-76ae8be7e851" --message="Optional commit message"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
source

The ID of the environment to deploy code from.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–message

An optional commit message to include when creating a new tag.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–cloud-actions

An optional array of Cloud Actions.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:environments:code-switch

Switches code on this environment to a different branch or release tag.

Usage
  • api:environments:code-switch [--cloud-actions CLOUD-ACTIONS] [--] <environmentId> <branch>
  • api:environments:code-switch 12-d314739e-296f-11e9-b210-d663bd873d93 "my-feature-branch"
  • api:environments:code-switch myapp.dev "my-feature-branch"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
branch

The name of the branch or tag to switch to.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–cloud-actions

An optional array of Cloud Actions.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:environments:site-import

Imports a site to this environment.

Usage
  • api:environments:site-import [--name NAME] [--] <environmentId> <url>
  • api:environments:site-import 12-d314739e-296f-11e9-b210-d663bd873d93 "http://www.example.com/path/to/site.tar.gz" --name="Drupal 8"
  • api:environments:site-import myapp.dev "http://www.example.com/path/to/site.tar.gz" --name="Drupal 8"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
url

The URL of the make file or tarball containing the site to import.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The name of the distribution being installed.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:cron-job-list

Return environment cron jobs.

Usage
  • api:environments:cron-job-list <environmentId>
  • api:environments:cron-job-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:cron-job-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cron-create

Creates a scheduled job with cron.

Usage
  • api:environments:cron-create <environmentId> <cron_command> <frequency> <label>
  • api:environments:cron-create 12-d314739e-296f-11e9-b210-d663bd873d93 "*/30 * * * *" "My New Cron"
  • api:environments:cron-create myapp.dev "*/30 * * * *" "My New Cron"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cron_command

The command to run.

  • Is required: yes
  • Is array: no
  • Default: NULL
frequency

The cron string that describes the frequency the cron will be run at.

  • Is required: yes
  • Is array: no
  • Default: NULL
label

The label for this cron.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cron-find

Return details about a specific cron job.

Usage
  • api:environments:cron-find <environmentId> <cronId>
  • api:environments:cron-find 12-d314739e-296f-11e9-b210-d663bd873d93 e10a665c-c9ec-4422-a82b-b32c82329f9d
  • api:environments:cron-find myapp.dev e10a665c-c9ec-4422-a82b-b32c82329f9d

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cronId

An ID that uniquely identifies a cron job.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cron-update

Modify an existing scheduled job.

Usage
  • api:environments:cron-update [--cron_command CRON_COMMAND] [--frequency FREQUENCY] [--label LABEL] [--] <environmentId> <cronId>
  • api:environments:cron-update 12-d314739e-296f-11e9-b210-d663bd873d93 e10a665c-c9ec-4422-a82b-b32c82329f9d --frequency="*/5 * * * *"
  • api:environments:cron-update myapp.dev e10a665c-c9ec-4422-a82b-b32c82329f9d --frequency="*/5 * * * *"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cronId

An ID that uniquely identifies a cron job.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–cron_command

The command to run.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–frequency

The cron string that describes the frequency the cron will be run at.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–label

The label for this cron.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:cron-delete

Deletes a cron job.

Usage
  • api:environments:cron-delete <environmentId> <cronId>
  • api:environments:cron-delete 12-d314739e-296f-11e9-b210-d663bd873d93 e10a665c-c9ec-4422-a82b-b32c82329f9d
  • api:environments:cron-delete myapp.dev e10a665c-c9ec-4422-a82b-b32c82329f9d

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cronId

An ID that uniquely identifies a cron job.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cron-enable

Enables a cron job.

Usage
  • api:environments:cron-enable <environmentId> <cronId>
  • api:environments:cron-enable 12-d314739e-296f-11e9-b210-d663bd873d93 e10a665c-c9ec-4422-a82b-b32c82329f9d
  • api:environments:cron-enable myapp.dev e10a665c-c9ec-4422-a82b-b32c82329f9d

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cronId

An ID that uniquely identifies a cron job.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:cron-disable

Disables a cron job.

Usage
  • api:environments:cron-disable <environmentId> <cronId>
  • api:environments:cron-disable 12-d314739e-296f-11e9-b210-d663bd873d93 e10a665c-c9ec-4422-a82b-b32c82329f9d
  • api:environments:cron-disable myapp.dev e10a665c-c9ec-4422-a82b-b32c82329f9d

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
cronId

An ID that uniquely identifies a cron job.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-list

Returns a list of databases.

Usage
  • api:environments:database-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
  • api:environments:database-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:database-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:database-copy

Copies a database to this environment.

Usage
  • api:environments:database-copy <environmentId> <name> <source>
  • api:environments:database-copy 12-d314739e-296f-11e9-b210-d663bd873d93 "db_name" "14-0c7e79ab-1c4a-424e-8446-76ae8be7e851"
  • api:environments:database-copy myapp.dev "db_name" "14-0c7e79ab-1c4a-424e-8446-76ae8be7e851"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The name of the database to copy to the selected environment.

  • Is required: yes
  • Is array: no
  • Default: NULL
source

The ID of the environment to copy the database from.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-find

Return details about a specific database.

Usage
  • api:environments:database-find <environmentId> <databaseName>
  • api:environments:database-find 12-d314739e-296f-11e9-b210-d663bd873d93 my_db
  • api:environments:database-find myapp.dev my_db

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-php-config-find

Returns PHP configuration details for this database.

Usage
  • api:environments:database-php-config-find <environmentId> <databaseName>
  • api:environments:database-php-config-find 12-d314739e-296f-11e9-b210-d663bd873d93 my_db
  • api:environments:database-php-config-find myapp.dev my_db

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-backup-list

Returns a list of backups.

Usage
  • api:environments:database-backup-list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId> <databaseName>
  • api:environments:database-backup-list 12-d314739e-296f-11e9-b210-d663bd873d93 my_db --from="2019-10-01T00:00:00.000Z" --to="2020-01-01T00:00:00.000Z" --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:database-backup-list myapp.dev my_db --from="2019-10-01T00:00:00.000Z" --to="2020-01-01T00:00:00.000Z" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

(Use filter from instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with to query.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

(Use filter to instead.) Specifies an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) formatted date. Used in conjunction with from query.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:database-backup-create

Create a backup.

Usage
  • api:environments:database-backup-create <environmentId> <databaseName>
  • api:environments:database-backup-create 12-d314739e-296f-11e9-b210-d663bd873d93 my_db
  • api:environments:database-backup-create myapp.dev my_db

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-backup-find

Return details about a specific backup.

Usage
  • api:environments:database-backup-find <environmentId> <databaseName> <backupId>
  • api:environments:database-backup-find 12-d314739e-296f-11e9-b210-d663bd873d93 my_db 1
  • api:environments:database-backup-find myapp.dev my_db 1

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL
backupId

The database backup identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-backup-delete

Deletes a database backup.

Usage
  • api:environments:database-backup-delete <environmentId> <databaseName> <backupId>
  • api:environments:database-backup-delete 12-d314739e-296f-11e9-b210-d663bd873d93 my_db 1
  • api:environments:database-backup-delete myapp.dev my_db 1

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL
backupId

The database backup identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-backup-download

Downloads the database backup file.

Usage
  • api:environments:database-backup-download <environmentId> <databaseName> <backupId>
  • api:environments:database-backup-download 12-d314739e-296f-11e9-b210-d663bd873d93 my_db 1
  • api:environments:database-backup-download myapp.dev my_db 1

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL
backupId

The database backup identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:database-backup-restore

Restores this backup to the appropriate environment’s database.

Usage
  • api:environments:database-backup-restore <environmentId> <databaseName> <backupId>
  • api:environments:database-backup-restore 12-d314739e-296f-11e9-b210-d663bd873d93 my_db 1
  • api:environments:database-backup-restore myapp.dev my_db 1

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
databaseName

The database name, typically lower snake case.

  • Is required: yes
  • Is array: no
  • Default: NULL
backupId

The database backup identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:dns-find

Returns DNS configuration details for an environment.

Usage
  • api:environments:dns-find <environmentId>
  • api:environments:dns-find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:dns-find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:domain-list

Returns a list of domains.

Usage
  • api:environments:domain-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
  • api:environments:domain-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:domain-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:domain-create

Adds a domain to the environment.

Usage
  • api:environments:domain-create [--hostname HOSTNAME] [--] <environmentId>
  • api:environments:domain-create 12-d314739e-296f-11e9-b210-d663bd873d93 --hostname="example.com"
  • api:environments:domain-create myapp.dev --hostname="example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–hostname

The domain name to add.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:domain-find

Return details about a specific domain.

Usage
  • api:environments:domain-find <environmentId> <domain>
  • api:environments:domain-find 12-d314739e-296f-11e9-b210-d663bd873d93 example.com
  • api:environments:domain-find myapp.dev example.com

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain

A domain name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:domain-delete

Removes the domain from this environment.

Usage
  • api:environments:domain-delete <environmentId> <domain>
  • api:environments:domain-delete 12-d314739e-296f-11e9-b210-d663bd873d93 example.com
  • api:environments:domain-delete myapp.dev example.com

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain

A domain name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:domain-clear-caches

Clears the caches for the specified domain.

Usage
  • api:environments:domain-clear-caches <environmentId> <domain>
  • api:environments:domain-clear-caches 12-d314739e-296f-11e9-b210-d663bd873d93 example.com
  • api:environments:domain-clear-caches myapp.dev example.com

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain

A domain name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:domain-status-find

Returns details about the domain.

Usage
  • api:environments:domain-status-find <environmentId> <domain>
  • api:environments:domain-status-find 12-d314739e-296f-11e9-b210-d663bd873d93 example.com
  • api:environments:domain-status-find myapp.dev example.com

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
domain

A domain name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:email-status

Returns the status of Platform Email for an Environment.

Usage
  • api:environments:email-status <environmentId>
  • api:environments:email-status 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:email-status myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:email-disable

Disables email for an environment.

Usage
  • api:environments:email-disable <environmentId>
  • api:environments:email-disable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:email-disable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:email-enable

Enables email for an environment.

Usage
  • api:environments:email-enable <environmentId>
  • api:environments:email-enable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:email-enable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:file-copy

Copies files to this environment.

Usage
  • api:environments:file-copy [--source SOURCE] [--] <environmentId>
  • api:environments:file-copy 12-d314739e-296f-11e9-b210-d663bd873d93 --source="14-0c7e79ab-1c4a-424e-8446-76ae8be7e851"
  • api:environments:file-copy myapp.dev --source="14-0c7e79ab-1c4a-424e-8446-76ae8be7e851"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–source

The ID of the environment to copy files from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:log-list

Returns a list of log files for this environment available for download.

Usage
  • api:environments:log-list <environmentId>
  • api:environments:log-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:log-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-download

Downloads the log file.

Usage
  • api:environments:log-download <environmentId> <logType>
  • api:environments:log-download 12-d314739e-296f-11e9-b210-d663bd873d93 php-error
  • api:environments:log-download myapp.dev php-error

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logType

An ID that uniquely identifies a log type.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-create

Creates a log file snapshot.

Usage
  • api:environments:log-create [--from FROM] [--to TO] [--] <environmentId> <logType>
  • api:environments:log-create 12-d314739e-296f-11e9-b210-d663bd873d93 php-error --from="2021-01-29T22:45:21+00:00" --to="2021-01-29T23:55:21+00:00"
  • api:environments:log-create myapp.dev php-error --from="2021-01-29T22:45:21+00:00" --to="2021-01-29T23:55:21+00:00"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logType

An ID that uniquely identifies a log type.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

An ISO-8601 formatted date retrieve results from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

An ISO-8601 formatted date retrieve results to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:logstream-find

Returns a logstream url and metadata.

Usage
  • api:environments:logstream-find <environmentId>
  • api:environments:logstream-find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:logstream-find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:livedev-disable

Disable Live Development on this environment.

Usage
  • api:environments:livedev-disable [--discard DISCARD] [--] <environmentId>
  • api:environments:livedev-disable 12-d314739e-296f-11e9-b210-d663bd873d93 --discard="1"
  • api:environments:livedev-disable myapp.dev --discard="1"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–discard

Indicates whether uncommitted changes should be discarded or not.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:livedev-enable

Enable Live Development on this environment.

Usage
  • api:environments:livedev-enable <environmentId>
  • api:environments:livedev-enable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:livedev-enable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-forwarding-destination-list

Returns a collection of log forwarding destinations for this environment.

Usage
  • api:environments:log-forwarding-destination-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
  • api:environments:log-forwarding-destination-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:log-forwarding-destination-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:log-forwarding-destination-create

Creates a log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-create [--address ADDRESS] [--] <environmentId> <label> <consumer> <credentials> <sources>...
  • api:environments:log-forwarding-destination-create 12-d314739e-296f-11e9-b210-d663bd873d93 "Test destination" "apache-access" "apache-error" "syslog" "{"certificate":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"}"" --address="example.com:1234"
  • api:environments:log-forwarding-destination-create myapp.dev "Test destination" "apache-access" "apache-error" "syslog" "{"certificate":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"}"" --address="example.com:1234"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
label

The human-friendly identifier of the destination.

  • Is required: yes
  • Is array: no
  • Default: NULL
consumer

The application or provider consuming the logs.

  • Is required: yes
  • Is array: no
  • Default: NULL
credentials

Credential information.

  • Is required: yes
  • Is array: no
  • Default: NULL
sources

The list of log sources to forward.

  • Is required: yes
  • Is array: yes
  • Default: array ()
Options
–address

The URL or host name and port of the destination.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:log-forwarding-destination-find

Returns the specified log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-find <environmentId> <logForwardingDestinationUuid>
  • api:environments:log-forwarding-destination-find 12-d314739e-296f-11e9-b210-d663bd873d93 dbd8a966-2b25-11e9-b210-d663bd873d93
  • api:environments:log-forwarding-destination-find myapp.dev dbd8a966-2b25-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logForwardingDestinationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-forwarding-destination-update

Updates an environment’s log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-update [--label LABEL] [--credentials CREDENTIALS] [--address ADDRESS] [--sources SOURCES] [--] <environmentId> <logForwardingDestinationUuid> <consumer>
  • api:environments:log-forwarding-destination-update 12-d314739e-296f-11e9-b210-d663bd873d93 dbd8a966-2b25-11e9-b210-d663bd873d93 --label="Test destination" --sources="apache-access" --sources="apache-error" "syslog" --credentials="{"certificate":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"}"" --address="example.com:1234"
  • api:environments:log-forwarding-destination-update myapp.dev dbd8a966-2b25-11e9-b210-d663bd873d93 --label="Test destination" --sources="apache-access" --sources="apache-error" "syslog" --credentials="{"certificate":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"}"" --address="example.com:1234"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logForwardingDestinationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
consumer

The application or provider consuming the logs.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–label

The human-friendly identifier of the destination.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–credentials

Credential information.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–address

The URL or host name and port of the destination.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sources

The list of log sources to forward.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:environments:log-forwarding-destination-delete

Deletes the specified log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-delete <environmentId> <logForwardingDestinationUuid>
  • api:environments:log-forwarding-destination-delete 12-d314739e-296f-11e9-b210-d663bd873d93 dbd8a966-2b25-11e9-b210-d663bd873d93
  • api:environments:log-forwarding-destination-delete myapp.dev dbd8a966-2b25-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logForwardingDestinationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-forwarding-destination-disable

Disables the specified log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-disable <environmentId> <logForwardingDestinationUuid>
  • api:environments:log-forwarding-destination-disable 12-d314739e-296f-11e9-b210-d663bd873d93 dbd8a966-2b25-11e9-b210-d663bd873d93
  • api:environments:log-forwarding-destination-disable myapp.dev dbd8a966-2b25-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logForwardingDestinationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:log-forwarding-destination-enable

Enables the specified log forwarding destination.

Usage
  • api:environments:log-forwarding-destination-enable <environmentId> <logForwardingDestinationUuid>
  • api:environments:log-forwarding-destination-enable 12-d314739e-296f-11e9-b210-d663bd873d93 dbd8a966-2b25-11e9-b210-d663bd873d93
  • api:environments:log-forwarding-destination-enable myapp.dev dbd8a966-2b25-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
logForwardingDestinationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:metrics

Does not return any data. Allows traversal to metrics groups endpoints.

Usage
  • api:environments:metrics <environmentId>
  • api:environments:metrics 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:metrics myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:stack-metrics-data-list

Does not return any data. Allows traversal to StackMetrics endpoints.

Usage
  • api:environments:stack-metrics-data-list <environmentId>
  • api:environments:stack-metrics-data-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:stack-metrics-data-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:stack-metrics-data-find

Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).

Usage
  • api:environments:stack-metrics-data-find [--to TO] [--resolution RESOLUTION] [--] <environmentId> <filter> <from>
  • api:environments:stack-metrics-data-find 12-d314739e-296f-11e9-b210-d663bd873d93 2021-01-29T22:45:21+00:00 --to="2021-01-29T23:55:21+00:00"
  • api:environments:stack-metrics-data-find myapp.dev 2021-01-29T22:45:21+00:00 --to="2021-01-29T23:55:21+00:00"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: = (%3D) * Does not equal: != (!%3D) * Greater than: > (%3E) * Less than: < (%3C) * Greater than or equal to: >= (%3E%3D) * Less than or equal to: <= (%3C%3D) * Contains substring: =@ (%3D@) * Does not contain substring: !@ (!@) Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;). Some examples: * filter=field%3Dvalue (field equals ‘value’) * filter=field%3D@*partialmatch (field ends with ‘partialmatch’) * filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’) * filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5) For this endpoint, the “metric” filter is required. Multiple metrics can be returned in one request. The following metrics are available: * apache-requests, bal-cpu, bal-memory, cron-memory, db-cpu, db-disk-size, db-disk-usage, db-memory, file-disk-size, file-cpu, file-disk-usage, file-memory, http-2xx, http-3xx, http-4xx, http-5xx, mysql-slow-query-count, nginx-requests, out-of-memory, php-proc-max-reached-site, php-proc-max-reached-total, php-proc-site, php-proc-total, varnish-cache-hit-rate, varnish-requests, web-cpu, web-memory

  • Is required: yes
  • Is array: no
  • Default: NULL
from

An ISO-8601 formatted date retrieve metrics from.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–to

An ISO-8601 formatted date retrieve results to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:usage-data

Retrieves usage data for an environment.

Usage
  • api:environments:usage-data [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <environmentId>
  • api:environments:usage-data 12-d314739e-296f-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"
  • api:environments:usage-data myapp.dev --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:usage-metric-data

Retrieves usage metric data for an environment.

Usage
  • api:environments:usage-metric-data [--from FROM] [--to TO] [--] <usageMetric> <environmentId>
  • api:environments:usage-metric-data views12-d314739e-296f-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"
  • api:environments:usage-metric-data views12-d314739e-296f-11e9-b210-d663bd873d93 myapp.dev --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
usageMetric

A usage data metric type.

  • Is required: yes
  • Is array: no
  • Default: NULL
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:production-mode-disable

Disables production mode for an environment.

Usage
  • api:environments:production-mode-disable <environmentId>
  • api:environments:production-mode-disable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:production-mode-disable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:production-mode-enable

Enables production mode for an environment.

Usage
  • api:environments:production-mode-enable <environmentId>
  • api:environments:production-mode-enable 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:production-mode-enable myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:search:list

Returns a traversal endpoint for search entities for the environment.

Usage
  • api:environments:search:list <environmentId>
  • api:environments:search:list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:search:list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:search:indexes-list

Returns a collection of search indexes for an environment.

Usage
  • api:environments:search:indexes-list <environmentId>
  • api:environments:search:indexes-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:search:indexes-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:search:index-create

Creates a search index for an environment.

Usage
  • api:environments:search:index-create [--config_set_id CONFIG_SET_ID] [--] <environmentId> <database_role>
  • api:environments:search:index-create 12-d314739e-296f-11e9-b210-d663bd873d93 --config_set_id="ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78" "example"
  • api:environments:search:index-create myapp.dev --config_set_id="ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78" "example"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
database_role

The database role for the search index.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–config_set_id

A configuration set ID to assign to the index.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:search:index-find

Returns a search configuration set for an application

Usage
  • api:environments:search:index-find <environmentId> <indexId>
  • api:environments:search:index-find 12-d314739e-296f-11e9-b210-d663bd873d93 ABCDE-1234.test.example
  • api:environments:search:index-find myapp.dev ABCDE-1234.test.example

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
indexId

An ID that uniquely identifies an index.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:search:index-update

Updates a search index on an environment.

Usage
  • api:environments:search:index-update [--config_set_id CONFIG_SET_ID] [--] <environmentId> <indexId>
  • api:environments:search:index-update 12-d314739e-296f-11e9-b210-d663bd873d93 ABCDE-1234.test.example --config_set_id="ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78"
  • api:environments:search:index-update myapp.dev ABCDE-1234.test.example --config_set_id="ABCDE-1234.12345ab6c7e8f90g12i1jk234l56mn78"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
indexId

An ID that uniquely identifies an index.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–config_set_id

The configuration set ID to update to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:search:index-delete

Removes and deletes a specific search index from an environment

Usage
  • api:environments:search:index-delete <environmentId> <indexId>
  • api:environments:search:index-delete 12-d314739e-296f-11e9-b210-d663bd873d93 ABCDE-1234.test.example
  • api:environments:search:index-delete myapp.dev ABCDE-1234.test.example

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
indexId

An ID that uniquely identifies an index.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:servers-list

Returns a list of servers.

Usage
  • api:environments:servers-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
  • api:environments:servers-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:servers-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:server-find

Return details about a specific server.

Usage
  • api:environments:server-find <environmentId> <serverId>
  • api:environments:server-find 12-d314739e-296f-11e9-b210-d663bd873d93 42
  • api:environments:server-find myapp.dev 42

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:server-update

Modifies configuration settings for a server.

Usage
  • api:environments:server-update [--memcache MEMCACHE] [--] <environmentId> <serverId>
  • api:environments:server-update 12-d314739e-296f-11e9-b210-d663bd873d93 42 --memcache="128"
  • api:environments:server-update myapp.dev 42 --memcache="128"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–memcache

The size (in MB) of memcache on this server.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:server-reboot

Reboots a server.

Usage
  • api:environments:server-reboot <environmentId> <serverId>
  • api:environments:server-reboot 12-d314739e-296f-11e9-b210-d663bd873d93 42
  • api:environments:server-reboot myapp.dev 42

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:server-relaunch

Relaunches a server.

Usage
  • api:environments:server-relaunch <environmentId> <serverId>
  • api:environments:server-relaunch 12-d314739e-296f-11e9-b210-d663bd873d93 42
  • api:environments:server-relaunch myapp.dev 42

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:server-suspend

Suspends a server.

Usage
  • api:environments:server-suspend <environmentId> <serverId>
  • api:environments:server-suspend 12-d314739e-296f-11e9-b210-d663bd873d93 42
  • api:environments:server-suspend myapp.dev 42

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:server-upgrade

Upgrades a server from “precise” to “xenial”.

Usage
  • api:environments:server-upgrade <environmentId> <serverId>
  • api:environments:server-upgrade 12-d314739e-296f-11e9-b210-d663bd873d93 42
  • api:environments:server-upgrade myapp.dev 42

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
serverId

The internal database identifier of the server.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:settings

Provides links to environment settings.

Usage
  • api:environments:settings <environmentId>
  • api:environments:settings 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:settings myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:ssl-settings-find

Returns the SSL settings for this environment.

Usage
  • api:environments:ssl-settings-find <environmentId>
  • api:environments:ssl-settings-find 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:ssl-settings-find myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:certificate-list

Return a list of SSL certificates.

Usage
  • api:environments:certificate-list <environmentId>
  • api:environments:certificate-list 12-d314739e-296f-11e9-b210-d663bd873d93
  • api:environments:certificate-list myapp.dev

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:certificate-create

Install an SSL certificate.

Usage
  • api:environments:certificate-create [--legacy LEGACY] [--ca_certificates CA_CERTIFICATES] [--csr_id CSR_ID] [--label LABEL] [--] <environmentId> <certificate> <private_key>
  • api:environments:certificate-create 12-d314739e-296f-11e9-b210-d663bd873d93 --legacy="" "-----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE-----" "-----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY-----" --ca_certificates="-----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE-----" --csr_id="123" --label="My New Cert"
  • api:environments:certificate-create myapp.dev --legacy="" "-----BEGIN CERTIFICATE-----abc123....-----END CERTIFICATE-----" "-----BEGIN RSA PRIVATE KEY-----secret....-----END RSA PRIVATE KEY-----" --ca_certificates="-----BEGIN CERTIFICATE-----123abc....-----END CERTIFICATE-----" --csr_id="123" --label="My New Cert"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificate

The SSL certificate being installed.

  • Is required: yes
  • Is array: no
  • Default: NULL
private_key

The SSL private key.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–legacy

Must be set to true for legacy certificates.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–ca_certificates

The CA intermediary certificates.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–csr_id

The CSR (certificate signing request) to associate with this certificate. Optional.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–label

The label for this certificate. Required for standard certificates. Optional for legacy certificates.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:certificate-find

Returns a specific certificate by certificate id.

Usage
  • api:environments:certificate-find <environmentId> <certificateId>
  • api:environments:certificate-find 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:certificate-find myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:certificate-delete

Deletes a specific certificate by its ID.

Usage
  • api:environments:certificate-delete <environmentId> <certificateId>
  • api:environments:certificate-delete 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:certificate-delete myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:certificate-activate

Activates an SSL certificate.

Usage
  • api:environments:certificate-activate <environmentId> <certificateId>
  • api:environments:certificate-activate 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:certificate-activate myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:certificate-deactivate

Deactivates an active SSL certificate.

Usage
  • api:environments:certificate-deactivate <environmentId> <certificateId>
  • api:environments:certificate-deactivate 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:certificate-deactivate myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:csr-find

Returns the certificate signing request for the certificate specified by id.

Usage
  • api:environments:csr-find <environmentId> <certificateId>
  • api:environments:csr-find 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:csr-find myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:csr-create

Generates a certificate signing request (CSR) for one or more domains.

Usage
  • api:environments:csr-create [--alternate_names ALTERNATE_NAMES] [--] <environmentId> <country> <state> <locality> <organization> <organizational_unit> <common_name>
  • api:environments:csr-create 12-d314739e-296f-11e9-b210-d663bd873d93 "CA" "Ontario" "Toronto" "Acquia" "Networking" "www.example.com" --alternate_names="www2.example.com" --alternate_names="www3.example.com"
  • api:environments:csr-create myapp.dev "CA" "Ontario" "Toronto" "Acquia" "Networking" "www.example.com" --alternate_names="www2.example.com" --alternate_names="www3.example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
country

The ISO-3166 country code for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
state

The state/province for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
locality

The locality (city/town/township) for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
organization

The organization name for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
organizational_unit

The organizational unit (department) for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
common_name

The common name (domain) for CSR generation.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–alternate_names

The Subject Alternate Names (SNI only) for CSR generation.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:environments:csr-delete

Deletes the certificate signing request.

Usage
  • api:environments:csr-delete <environmentId> <certificateId>
  • api:environments:csr-delete 12-d314739e-296f-11e9-b210-d663bd873d93 7
  • api:environments:csr-delete myapp.dev 7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
certificateId

An ID that uniquely identifies a certificate.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:variable-list

Returns a list of environment variables associated with this environment.

Usage
  • api:environments:variable-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
  • api:environments:variable-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
  • api:environments:variable-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:variable-create

Adds a new environment variable to an environment.

Usage
  • api:environments:variable-create [--name NAME] [--value VALUE] [--] <environmentId>
  • api:environments:variable-create 12-d314739e-296f-11e9-b210-d663bd873d93 --name="APP_KEY" --value="aaaabbbbccccddddeee"
  • api:environments:variable-create myapp.dev --name="APP_KEY" --value="aaaabbbbccccddddeee"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The name of the environment variable to add.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–value

The value of the environment variable to add.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:environments:variable-find

Get an environment variable associated with this environment.

Usage
  • api:environments:variable-find <environmentId> <environmentVariableName>
  • api:environments:variable-find 12-d314739e-296f-11e9-b210-d663bd873d93 EXAMPLE_VARIABLE_NAME
  • api:environments:variable-find myapp.dev EXAMPLE_VARIABLE_NAME

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
environmentVariableName

The environment variable name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:variable-delete

Removes an environment variable from an environment.

Usage
  • api:environments:variable-delete <environmentId> <environmentVariableName>
  • api:environments:variable-delete 12-d314739e-296f-11e9-b210-d663bd873d93 EXAMPLE_VARIABLE_NAME
  • api:environments:variable-delete myapp.dev EXAMPLE_VARIABLE_NAME

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
environmentVariableName

The environment variable name.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:environments:variable-update

Updates an environment variable on an environment.

Usage
  • api:environments:variable-update <environmentId> <environmentVariableName> <name> <value>
  • api:environments:variable-update 12-d314739e-296f-11e9-b210-d663bd873d93 EXAMPLE_VARIABLE_NAME "aaaabbbbccccddddeee"
  • api:environments:variable-update myapp.dev EXAMPLE_VARIABLE_NAME "aaaabbbbccccddddeee"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
environmentId

The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.

  • Is required: yes
  • Is array: no
  • Default: NULL
environmentVariableName

The environment variable name.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The name of the environment variable to add.

  • Is required: yes
  • Is array: no
  • Default: NULL
value

The value of the environment variable to add.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:ide:find

Returns Cloud IDE info.

Usage
  • api:ide:find <ideUuid>
  • api:ide:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
ideUuid

The Cloud IDE universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:ide:delete

De-provisions a specific Cloud IDE.

Usage
  • api:ide:delete <ideUuid>
  • api:ide:delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
ideUuid

The Cloud IDE universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:identity-providers:list

Returns a list of identity providers for a user.

Usage
  • api:identity-providers:list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:identity-providers:list --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:identity-providers:find

Returns a specific identity provider by UUID.

Usage
  • api:identity-providers:find <identityProviderUuid>
  • api:identity-providers:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
identityProviderUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:identity-providers:update

Modifies an identity provider by its UUID.

Usage
  • api:identity-providers:update [--label LABEL] [--entity_id ENTITY_ID] [--sso_url SSO_URL] [--certificate CERTIFICATE] [--] <identityProviderUuid>
  • api:identity-providers:update da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --label="New label" --entity_id="entity-id" --sso_url="https://idp.example.com" --certificate="-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
identityProviderUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–label

The new identity provider label.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–entity_id

The entity ID of the identity provider

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sso_url

The URL of the SSO identity provider.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–certificate

The PEM-encoded X.509 certificate.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:identity-providers:delete

Deletes a specific identity provider by its UUID.

Usage
  • api:identity-providers:delete <identityProviderUuid>
  • api:identity-providers:delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
identityProviderUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:identity-providers:enable

Enables an identity provider by its UUID.

Usage
  • api:identity-providers:enable <identityProviderUuid>
  • api:identity-providers:enable da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
identityProviderUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:identity-providers:disable

Disables an identity provider by its UUID.

Usage
  • api:identity-providers:disable <identityProviderUuid>
  • api:identity-providers:disable da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
identityProviderUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:invites:find

Returns details about an invitation.

Usage
  • api:invites:find <token>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
token

The token identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:invites:cancel

Cancels an invitation.

Usage
  • api:invites:cancel <token>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
token

The token identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:invites:accept

Accepts an invite.

Usage
  • api:invites:accept <token>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
token

The token identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:invites:decline

Declines an invite.

Usage
  • api:invites:decline <token>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
token

The token identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:invites:resend

Resend an invite.

Usage
  • api:invites:resend <token>

For more help, see https://cloudapi-docs.acquia.com/

Arguments
token

The token identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:messages:dismiss

Dismisses a message.

Usage
  • api:messages:dismiss <messageUuid>
  • api:messages:dismiss da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
messageUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:messages:follow

Follows an in-product message link.

Usage
  • api:messages:follow <messageUuid>
  • api:messages:follow da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
messageUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:notifications:find

Returns a single notification.

Usage
  • api:notifications:find <notificationUuid>
  • api:notifications:find 2343b683-b194-4217-982a-6a95c72ad9a8

For more help, see https://cloudapi-docs.acquia.com/

Arguments
notificationUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:options:list

Does not return any data. Allows traversal of options groups endpoints.

Usage
  • api:options:list

For more help, see https://cloudapi-docs.acquia.com/

api:options:cde-sizes-list

Displays the various CD Environment size options.

Usage
  • api:options:cde-sizes-list

For more help, see https://cloudapi-docs.acquia.com/

api:options:log-forwarding

Does not return any data. Allows traversal of options groups endpoints.

Usage
  • api:options:log-forwarding

For more help, see https://cloudapi-docs.acquia.com/

api:options:log-forwarding-source-list

Displays available log forwarding sources.

Usage
  • api:options:log-forwarding-source-list

For more help, see https://cloudapi-docs.acquia.com/

api:options:log-forwarding-consumer-list

Displays available log forwarding consumers.

Usage
  • api:options:log-forwarding-consumer-list

For more help, see https://cloudapi-docs.acquia.com/

api:colors:list

Displays the various color options.

Usage
  • api:colors:list

For more help, see https://cloudapi-docs.acquia.com/

api:organizations:list

Return a list of organizations.

Usage
  • api:organizations:list

For more help, see https://cloudapi-docs.acquia.com/

api:organizations:create

Creates a new organization.

Usage
  • api:organizations:create <name>
  • api:organizations:create "My new organization"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
name

The name of the organization.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:find

Return details about a specific organization.

Usage
  • api:organizations:find <organizationUuid>
  • api:organizations:find 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:update

Renames an organization.

Usage
  • api:organizations:update <organizationUuid> <name>
  • api:organizations:update 1e7efab9-0fac-4a2c-ad94-61efc78623ba "My renamed organization"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The new name of the organization.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:delete

Deletes a specific organization by its UUID.

Usage
  • api:organizations:delete <organizationUuid>
  • api:organizations:delete 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:owner-change

Changes the organization owner.

Usage
  • api:organizations:owner-change <organizationUuid> <user_uuid>
  • api:organizations:owner-change 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
user_uuid

The uuid of the user you want to make the owner for this organization.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:leave

Removes your account from an organization.

Usage
  • api:organizations:leave <organizationUuid>
  • api:organizations:leave 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:admin-list

Returns a list of organization administrators.

Usage
  • api:organizations:admin-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <organizationUuid>
  • api:organizations:admin-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:admin-find

Returns the user profile of this organization administrator.

Usage
  • api:organizations:admin-find <organizationUuid> <userUuid>
  • api:organizations:admin-find 1e7efab9-0fac-4a2c-ad94-61efc78623ba f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:admin-delete

Removes the user from the list of administrators for the organization.

Usage
  • api:organizations:admin-delete <organizationUuid> <userUuid>
  • api:organizations:admin-delete 1e7efab9-0fac-4a2c-ad94-61efc78623ba f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:admin-invite-list

Gets a list of invitations of administrators for this organization.

Usage
  • api:organizations:admin-invite-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--range RANGE] [--] <organizationUuid>
  • api:organizations:admin-invite-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–range

ISO-8601 date/time of invite create date/time.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:admin-invite-create

Invites a user to be an administrator in this organization.

Usage
  • api:organizations:admin-invite-create <organizationUuid> <email>
  • api:organizations:admin-invite-create 1e7efab9-0fac-4a2c-ad94-61efc78623ba "invitee@example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
email

The email address of the user to invite as an administrator for this organization.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:applications-list

Returns a list of applications that belong to the organization.

Usage
  • api:organizations:applications-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <organizationUuid>
  • api:organizations:applications-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:available-tags-list

Returns a list of all available application tags.

Usage
  • api:organizations:available-tags-list <organizationUuid>
  • api:organizations:available-tags-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:available-tags-create

Adds bulk tags to organization resources.

Usage
  • api:organizations:available-tags-create <organizationUuid> <context> <tags>...
  • api:organizations:available-tags-create 1e7efab9-0fac-4a2c-ad94-61efc78623ba "[{"name":"tag-name-1","color":"green"},{"name":"tag-name-2","color":"blue"}]" "{"application":{"uuids":["96e10bfb-1e4f-41c3-9d07-fffe8aba50d5"]}}""

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
context

Context resources of tags. Currently supports application identifier and uuids type.

  • Is required: yes
  • Is array: no
  • Default: NULL
tags

A list of tags to be added.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:organizations:available-tags-delete

Deletes bulk tags from organization resources.

Usage
  • api:organizations:available-tags-delete <organizationUuid> <context> <tags>...
  • api:organizations:available-tags-delete 1e7efab9-0fac-4a2c-ad94-61efc78623ba "[{"name":"tag-name-1"},{"name":"tag-name-2"}]" "{"application":{"uuids":["96e10bfb-1e4f-41c3-9d07-fffe8aba50d5"]}}""

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
context

Context resources of tags. Currently supports application identifier and uuids type.

  • Is required: yes
  • Is array: no
  • Default: NULL
tags

A list of tags to be deleted.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:organizations:identity-provider-find

Returns an identity provider for an organization.

Usage
  • api:organizations:identity-provider-find <organizationUuid>
  • api:organizations:identity-provider-find 1e7efab9-0fac-4a2c-ad94-61efc78623ba

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:members-list

Returns a list of all organization members.

Usage
  • api:organizations:members-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--] <organizationUuid>
  • api:organizations:members-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:member-find

Returns the user profile of this organization member.

Usage
  • api:organizations:member-find <organizationUuid> <userUuid>
  • api:organizations:member-find 1e7efab9-0fac-4a2c-ad94-61efc78623ba f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:member-delete

Removes the member from the organization.

Usage
  • api:organizations:member-delete <organizationUuid> <userUuid>
  • api:organizations:member-delete 1e7efab9-0fac-4a2c-ad94-61efc78623ba f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:member-application-list

Returns a list of applications that an organization member has access to.

Usage
  • api:organizations:member-application-list <organizationUuid> <userUuid>
  • api:organizations:member-application-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:organizations:roles-list

Returns a list of all the canonical roles within the organization.

Usage
  • api:organizations:roles-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--range RANGE] [--] <organizationUuid>
  • api:organizations:roles-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–range

ISO-8601 date/time of invite create date/time.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:role-create

Creates a role.

Usage
  • api:organizations:role-create [--description DESCRIPTION] [--] <organizationUuid> <name> <permissions>...
  • api:organizations:role-create 1e7efab9-0fac-4a2c-ad94-61efc78623ba "My new role" --description="My role description" "permission 1" "permission 2"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The name of the new role to create.

  • Is required: yes
  • Is array: no
  • Default: NULL
permissions

An array of permissions to grant to this role.

  • Is required: yes
  • Is array: yes
  • Default: array ()
Options
–description

The description of the new role.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:subscriptions-list

Returns a list of subscriptions that belong to the organization.

Usage
  • api:organizations:subscriptions-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--range RANGE] [--] <organizationUuid>
  • api:organizations:subscriptions-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–range

ISO-8601 date/time of invite create date/time.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:team-invite-list

Gets a list of member invitations for all teams in this organization.

Usage
  • api:organizations:team-invite-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <organizationUuid>
  • api:organizations:team-invite-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:team-list

Returns a list of teams associated with the organization.

Usage
  • api:organizations:team-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <organizationUuid>
  • api:organizations:team-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:organizations:team-create

Creates a team.

Usage
  • api:organizations:team-create <organizationUuid> <name>
  • api:organizations:team-create 1e7efab9-0fac-4a2c-ad94-61efc78623ba "My new team"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
organizationUuid

The organization entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
name

The name of the new team to create.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:permissions:list

Return a list of permissions.

Usage
  • api:permissions:list

For more help, see https://cloudapi-docs.acquia.com/

api:tps:role-find

Return details about a specific role.

Usage
  • api:tps:role-find <roleUuid>
  • api:tps:role-find da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
roleUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:roles-delete

Deletes a specific role by its UUID.

Usage
  • api:tps:roles-delete <roleUuid>
  • api:tps:roles-delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
roleUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:role-update

Updates a role.

Usage
  • api:tps:role-update [--name NAME] [--description DESCRIPTION] [--permissions PERMISSIONS] [--] <roleUuid>
  • api:tps:role-update da1c0a8e-ff69-45db-88fc-acd6d2affbb7 --name="My new role name" --description="My new role description."

For more help, see https://cloudapi-docs.acquia.com/

Arguments
roleUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The new name of the role.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–description

The new description of the role.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–permissions

An array of the permissions associated with the role.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:subscriptions:list

Return a list of subscription.

Usage
  • api:subscriptions:list [--from FROM] [--to TO] [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET]
  • api:subscriptions:list --from="-7d" --to="-1d" --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:find

Return details about a specific subscription.

Usage
  • api:subscriptions:find <subscriptionUuid>
  • api:subscriptions:find 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:update

Modifies a subscription.

Usage
  • api:subscriptions:update [--name NAME] [--] <subscriptionUuid>
  • api:subscriptions:update 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The new subscription name.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:apm-list

Returns the Application Performance Monitoring service type associated with the subscription.

Usage
  • api:subscriptions:apm-list <subscriptionUuid> <apmType>
  • api:subscriptions:apm-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93 newrelic

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
apmType

The APM type.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:apm-opt-in

Enables New Relic Pro APM license for all applications on a subscription.

Usage
  • api:subscriptions:apm-opt-in <subscriptionUuid> <apmType>
  • api:subscriptions:apm-opt-in 0f3ad33e-2fe4-11e9-b210-d663bd873d93 newrelic

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
apmType

The APM type.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:application-list

Provides a list of applications that are a part of the subscription.

Usage
  • api:subscriptions:application-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <subscriptionUuid>
  • api:subscriptions:application-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:domain-registrations-list

Returns a list of Domains registered with this subscription.

Usage
  • api:subscriptions:domain-registrations-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <subscriptionUuid>
  • api:subscriptions:domain-registrations-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:post-domain-registration

Registers a Domain with this subscription.

Usage
  • api:subscriptions:post-domain-registration [--domain DOMAIN] [--] <subscriptionUuid>
  • api:subscriptions:post-domain-registration 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --domain="example.com"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–domain

The domain name to add.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:get-domain-registration

Returns a speicific Domain registered with this subscription.

Usage
  • api:subscriptions:get-domain-registration <subscriptionUuid> <domainRegistrationUuid>
  • api:subscriptions:get-domain-registration 0f3ad33e-2fe4-11e9-b210-d663bd873d93 da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
domainRegistrationUuid

The Domain Registration universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:delete-domain-registration

Unregisters a Domain registered with this subscription.

Usage
  • api:subscriptions:delete-domain-registration <subscriptionUuid> <domainRegistrationUuid>
  • api:subscriptions:delete-domain-registration 0f3ad33e-2fe4-11e9-b210-d663bd873d93 da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
domainRegistrationUuid

The Domain Registration universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:post-verify-domain-registration

Triggers re-verification and update to the domain verification status.

Usage
  • api:subscriptions:post-verify-domain-registration <subscriptionUuid> <domainRegistrationUuid>
  • api:subscriptions:post-verify-domain-registration 0f3ad33e-2fe4-11e9-b210-d663bd873d93 da1c0a8e-ff69-45db-88fc-acd6d2affbb7

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
domainRegistrationUuid

The Domain Registration universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:entitlements-list

Provides a list of entitlements that are a part of the subscription.

Usage
  • api:subscriptions:entitlements-list <subscriptionUuid>
  • api:subscriptions:entitlements-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:ide-list

Returns a list of Cloud IDEs associated with this subscription.

Usage
  • api:subscriptions:ide-list <subscriptionUuid>
  • api:subscriptions:ide-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:usage-data

Retrieves aggregate usage data for a subscription.

Usage
  • api:subscriptions:usage-data [--filter FILTER] [--resolution RESOLUTION] [--] <subscriptionUuid>
  • api:subscriptions:usage-data 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:usage-data-by-application

Retrieves usage data for a subscription, broken down by application.

Usage
  • api:subscriptions:usage-data-by-application [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <subscriptionUuid>
  • api:subscriptions:usage-data-by-application 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:usage-metric-data

Retrieves aggregate usage metric data for a subscription.

Usage
  • api:subscriptions:usage-metric-data [--from FROM] [--to TO] [--] <usageMetric> <subscriptionUuid>
  • api:subscriptions:usage-metric-data views0f3ad33e-2fe4-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
usageMetric

A usage data metric type.

  • Is required: yes
  • Is array: no
  • Default: NULL
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:usage-views-data-by-application

Retrieves views data for a subscription, broken down by application.

Usage
  • api:subscriptions:usage-views-data-by-application [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <subscriptionUuid>
  • api:subscriptions:usage-views-data-by-application 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:usage-visits-data-by-application

Retrieves visits data for a subscription, broken down by application.

Usage
  • api:subscriptions:usage-visits-data-by-application [--from FROM] [--to TO] [--filter FILTER] [--resolution RESOLUTION] [--] <subscriptionUuid>
  • api:subscriptions:usage-visits-data-by-application 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --from="-7d" --to="-1d"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–from

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–to

Optionally specifies relative or absolute time period to retrieve results until.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–resolution

Specifies the data granularity of the request. Available resolutions: minute, hour, day, week or month.

Limits:

  • 3 hour limit for “minute” resolution
  • 1 week limit for “hour” resolution
  • 6 month limit for “day” resolution
  • 1 year limit for “week” resolution
  • 3 year limit for “month” resolution
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:shield-acl-list

Provides a list of Shield ACL rules.

Usage
  • api:subscriptions:shield-acl-list [--limit LIMIT] [--offset OFFSET] [--] <subscriptionUuid>
  • api:subscriptions:shield-acl-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93 --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:subscriptions:shield-acl-create

Creates a Shield ACL rule.

Usage
  • api:subscriptions:shield-acl-create [--description DESCRIPTION] [--addresses ADDRESSES] [--] <subscriptionUuid>
  • api:subscriptions:shield-acl-create 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–description

The description of the new Shield ACL rule.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–addresses

A list of IP addresses and/or CIDRs for this Shield ACL rule.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:subscriptions:shield-acl-find

Returns the specified Shield ACL rule.

Usage
  • api:subscriptions:shield-acl-find <subscriptionUuid> <shieldAclUuid>
  • api:subscriptions:shield-acl-find 0f3ad33e-2fe4-11e9-b210-d663bd873d93 a1234567-1234-123a-abc1-12ab345cd678

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
shieldAclUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:shield-acl-update

Updates a Shield ACL rule.

Usage
  • api:subscriptions:shield-acl-update [--description DESCRIPTION] [--addresses ADDRESSES] [--] <subscriptionUuid> <shieldAclUuid>
  • api:subscriptions:shield-acl-update 0f3ad33e-2fe4-11e9-b210-d663bd873d93 a1234567-1234-123a-abc1-12ab345cd678

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
shieldAclUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–description

The description of the new Shield ACL rule.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–addresses

A list of IP addresses and/or CIDRs for this Shield ACL rule.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()

api:subscriptions:shield-acl-delete

Deletes a Shield ACL rule.

Usage
  • api:subscriptions:shield-acl-delete <subscriptionUuid> <shieldAclUuid>
  • api:subscriptions:shield-acl-delete 0f3ad33e-2fe4-11e9-b210-d663bd873d93 a1234567-1234-123a-abc1-12ab345cd678

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
shieldAclUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:subscriptions:shield-acl-reset

Resets Shield ACL rules to default settings.

Usage
  • api:subscriptions:shield-acl-reset <subscriptionUuid>
  • api:subscriptions:shield-acl-reset 0f3ad33e-2fe4-11e9-b210-d663bd873d93

For more help, see https://cloudapi-docs.acquia.com/

Arguments
subscriptionUuid

The subscription entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:teams-list

Return teams the current user has access to.

Usage
  • api:tps:teams-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--range RANGE]
  • api:tps:teams-list --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–range

ISO-8601 date/time of invite create date/time.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:tps:team-find

Return details about a specific team.

Usage
  • api:tps:team-find <teamUuid>
  • api:tps:team-find 3eef5d81-62f4-429c-aa94-e17d05ab4740

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:team-update

Change the name of a team.

Usage
  • api:tps:team-update [--name NAME] [--] <teamUuid>
  • api:tps:team-update 3eef5d81-62f4-429c-aa94-e17d05ab4740 --name="My new team name"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–name

The new name of the team.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:tps:team-delete

Deletes a specific team by its UUID.

Usage
  • api:tps:team-delete <teamUuid>
  • api:tps:team-delete 3eef5d81-62f4-429c-aa94-e17d05ab4740

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:user-leave

Removes the current user from a team.

Usage
  • api:tps:user-leave <teamUuid>
  • api:tps:user-leave 3eef5d81-62f4-429c-aa94-e17d05ab4740

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:team-application-list

Returns a list of applications this team has access to.

Usage
  • api:tps:team-application-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <teamUuid>
  • api:tps:team-application-list 3eef5d81-62f4-429c-aa94-e17d05ab4740 --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:tps:team-application-add

Adds an application to this team.

Usage
  • api:tps:team-application-add <teamUuid> <uuid>
  • api:tps:team-application-add 3eef5d81-62f4-429c-aa94-e17d05ab4740 "a47ac10b-58cc-4372-a567-0e02b2c3d470"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
uuid

The uuid of the application to add to this team.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:team-application-remove

Removes the application from this team.

Usage
  • api:tps:team-application-remove <teamUuid> <applicationUuid>
  • api:tps:team-application-remove 3eef5d81-62f4-429c-aa94-e17d05ab4740 da1c0a8e-ff69-45db-88fc-acd6d2affbb7
  • api:tps:team-application-remove 3eef5d81-62f4-429c-aa94-e17d05ab4740 myapp

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
applicationUuid

The entity’s universally unique identifier. You may also use an application alias or omit the argument if you run the command in a linked directory.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:tps:team-invite-list

Returns a list of invitations to this team.

Usage
  • api:tps:team-invite-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--range RANGE] [--] <teamUuid>
  • api:tps:team-invite-list 3eef5d81-62f4-429c-aa94-e17d05ab4740 --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–range

ISO-8601 date/time of invite create date/time.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:tps:team-user-invite

Invites a user to join a team.

Usage
  • api:tps:team-user-invite <teamUuid> <email> <roles>...
  • api:tps:team-user-invite 3eef5d81-62f4-429c-aa94-e17d05ab4740 "person@example.com" "489efe35-7bb7-48b7-9aa2-f6f8f457c926" "8025e9a7-781a-4ad1-b7ea-1f1b732944c2"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
email

The email address of the user to invite to this team.

  • Is required: yes
  • Is array: no
  • Default: NULL
roles

The role UUIDs to grant to the invitee.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:tps:team-member-list

Returns a list of team members.

Usage
  • api:tps:team-member-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <teamUuid>
  • api:tps:team-member-list 3eef5d81-62f4-429c-aa94-e17d05ab4740 --sort="field1,-field2" --limit="10" --offset="10"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–sort

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–filter

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

  • Equals: = (%3D)
  • Does not equal: != (!%3D)
  • Greater than: > (%3E)
  • Less than: < (%3C)
  • Greater than or equal to: >= (%3E%3D)
  • Less than or equal to: <= (%3C%3D)
  • Contains substring: =@ (%3D@)
  • Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

  • filter=field%3Dvalue (field equals ‘value’)
  • filter=field%3D@*partialmatch (field ends with ‘partialmatch’)
  • filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)
  • filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–limit

The maximum number of items to return.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–offset

An integer to signify the offset to paginate from.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

api:tps:team-member-add

Grant team roles to a member.

Usage
  • api:tps:team-member-add <teamUuid> <userUuid> <roles>...
  • api:tps:team-member-add 3eef5d81-62f4-429c-aa94-e17d05ab4740 f2daa9cc-e5a0-4036-a5c8-f96e336c62b5 "489efe35-7bb7-48b7-9aa2-f6f8f457c926" "8025e9a7-781a-4ad1-b7ea-1f1b732944c2"

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
roles

The role UUIDs to grant to the user.

  • Is required: yes
  • Is array: yes
  • Default: array ()

api:tps:team-member-remove

Remove a user from a team.

Usage
  • api:tps:team-member-remove <teamUuid> <userUuid>
  • api:tps:team-member-remove 3eef5d81-62f4-429c-aa94-e17d05ab4740 f2daa9cc-e5a0-4036-a5c8-f96e336c62b5

For more help, see https://cloudapi-docs.acquia.com/

Arguments
teamUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL
userUuid

The entity’s universally unique identifier.

  • Is required: yes
  • Is array: no
  • Default: NULL

api:accounts

List all API commands for the accounts resource

Usage
  • api:accounts

List all API commands for the accounts resource

api:agreements

List all API commands for the agreements resource

Usage
  • api:agreements

List all API commands for the agreements resource

api:applications

List all API commands for the applications resource

Usage
  • api:applications

List all API commands for the applications resource

api:distributions

List all API commands for the distributions resource

Usage
  • api:distributions

List all API commands for the distributions resource

api:environments

List all API commands for the environments resource

Usage
  • api:environments

List all API commands for the environments resource

api:ide

List all API commands for the ide resource

Usage
  • api:ide

List all API commands for the ide resource

api:identity-providers

List all API commands for the identity-providers resource

Usage
  • api:identity-providers

List all API commands for the identity-providers resource

api:invites

List all API commands for the invites resource

Usage
  • api:invites

List all API commands for the invites resource

api:messages

List all API commands for the messages resource

Usage
  • api:messages

List all API commands for the messages resource

api:notifications

List all API commands for the notifications resource

Usage
  • api:notifications

List all API commands for the notifications resource

api:options

List all API commands for the options resource

Usage
  • api:options

List all API commands for the options resource

api:colors

List all API commands for the colors resource

Usage
  • api:colors

List all API commands for the colors resource

api:organizations

List all API commands for the organizations resource

Usage
  • api:organizations

List all API commands for the organizations resource

api:permissions

List all API commands for the permissions resource

Usage
  • api:permissions

List all API commands for the permissions resource

api:tps

List all API commands for the tps resource

Usage
  • api:tps

List all API commands for the tps resource

api:subscriptions

List all API commands for the subscriptions resource

Usage
  • api:subscriptions

List all API commands for the subscriptions resource

app

app:open

Opens your browser to view a given Cloud application

Usage
  • app:open [<applicationUuid>]
  • open
  • o
  • app:open [<applicationAlias>]
  • app:open myapp
  • app:open abcd1234-1111-2222-3333-0e02b2c3d470

Opens your browser to view a given Cloud application

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

app:log:tail

Tail the logs from your environments

Usage
  • app:log:tail [<environmentId>]
  • tail
  • log:tail
  • app:log:tail [<environmentAlias>]
  • app:log:tail myapp.dev
  • app:log:tail 12345-abcd1234-1111-2222-3333-0e02b2c3d470

Tail the logs from your environments

Arguments
environmentId

The Cloud Platform environment ID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

app:new:local

Create a new Drupal project

Usage
  • app:new:local [--distribution DISTRIBUTION] [--] [<directory>]
  • new

Create a new Drupal project

Arguments
directory

The destination directory

  • Is required: no
  • Is array: no
  • Default: NULL
Options
–distribution

The Composer package name of the Drupal distribution to download

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

auth

auth:acsf-login

Register your Site Factory API key and secret to use API functionality

Usage
  • auth:acsf-login [-u|--username USERNAME] [-k|--key KEY] [-f|--factory-url FACTORY-URL]

Register your Site Factory API key and secret to use API functionality

Options
–username|-u

The username for the Site Factory that you’d like to login to

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–key|-k

The key for your Site Factory user

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–factory-url|-f

The URL of your factory. E.g., https://www.acquia.com

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

auth:acsf-logout

Remove your Site Factory key and secret from your local machine.

Usage
  • auth:acsf-logout

Remove your Site Factory key and secret from your local machine.

auth:login

Register your Cloud API key and secret to use API functionality

Usage
  • auth:login [-k|--key KEY] [-s|--secret SECRET]
  • login

Register your Cloud API key and secret to use API functionality

Options
–key|-k
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–secret|-s
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

auth:logout

Remove Cloud API key and secret from local machine.

Usage
  • auth:logout
  • logout

Remove Cloud API key and secret from local machine.

email

email:configure

Configure Platform email for one or more applications

Usage
  • email:configure [<subscriptionUuid>]
  • ec

This command configures Platform Email for a domain in a subscription. It registers the domain with the subscription, associates the domain with an application or set of applications, and enables Platform Email for selected environments of these applications.

Arguments
subscriptionUuid

The subscription UUID to register the domain with.

  • Is required: no
  • Is array: no
  • Default: NULL

email:info

Print information related to Platform Email set up in a subscription.

Usage
  • email:info [<subscriptionUuid>]

This command lists information related to Platform Email for a subscription, including which domains have been validated, which have not, and which applications have Platform Email domains associated.

Arguments
subscriptionUuid

The subscription UUID whose Platform Email configuration is to be checked.

  • Is required: no
  • Is array: no
  • Default: NULL

env

env:cron-copy

Copy all cron tasks from one Acquia Cloud Platform environment to another

Usage
  • env:cron-copy <source_env> <dest_env>
  • env:cron-copy <srcEnvironmentAlias> <destEnvironmentAlias>
  • env:cron-copy myapp.dev myapp.prod
  • env:cron-copy abcd1234-1111-2222-3333-0e02b2c3d470 efgh1234-1111-2222-3333-0e02b2c3d470

Copy all cron tasks from one Acquia Cloud Platform environment to another

Arguments
source_env

Alias of the source environment in the format app-name.env or the environment uuid

  • Is required: yes
  • Is array: no
  • Default: NULL
dest_env

Alias of the destination environment in the format app-name.env or the environment uuid

  • Is required: yes
  • Is array: no
  • Default: NULL

env:create

Create a new Continuous Delivery Environment (CDE)

Usage
  • env:create <label> [<branch> [<applicationUuid>]]
  • env:create [<applicationAlias>]
  • env:create myapp
  • env:create abcd1234-1111-2222-3333-0e02b2c3d470

Create a new Continuous Delivery Environment (CDE)

Arguments
label

The label of the new environment

  • Is required: yes
  • Is array: no
  • Default: NULL
branch

The vcs path (git branch name) to deploy to the new environment

  • Is required: no
  • Is array: no
  • Default: NULL
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

env:delete

Delete a Continuous Delivery Environment (CDE)

Usage
  • env:delete [<environmentId>]
  • env:delete [<environmentAlias>]
  • env:delete myapp.dev
  • env:delete 12345-abcd1234-1111-2222-3333-0e02b2c3d470

Delete a Continuous Delivery Environment (CDE)

Arguments
environmentId

The Cloud Platform environment ID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

env:mirror

Makes one environment identical to another in terms of code, database, files, and configuration.

Usage
  • env:mirror [-c|--no-code] [-d|--no-databases] [-f|--no-files] [-p|--no-config] [--] <source-environment> <destination-environment>
  • env:mirror [<environmentAlias>]
  • env:mirror myapp.dev
  • env:mirror 12345-abcd1234-1111-2222-3333-0e02b2c3d470
  • env:mirror [<environmentAlias>]
  • env:mirror myapp.dev
  • env:mirror 12345-abcd1234-1111-2222-3333-0e02b2c3d470

Makes one environment identical to another in terms of code, database, files, and configuration.

Arguments
source-environment

The Cloud Platform source environment ID or alias

  • Is required: yes
  • Is array: no
  • Default: NULL
destination-environment

The Cloud Platform destination environment ID or alias

  • Is required: yes
  • Is array: no
  • Default: NULL
Options
–no-code|-c
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false
–no-databases|-d
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false
–no-files|-f
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false
–no-config|-p
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false

ide

ide:create

Create a Cloud IDE

Usage
  • ide:create [--label LABEL] [--] [<applicationUuid>]
  • ide:create [<applicationAlias>]
  • ide:create myapp
  • ide:create abcd1234-1111-2222-3333-0e02b2c3d470

Create a Cloud IDE

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL
Options
–label

The label for the IDE

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL

ide:delete

Delete a Cloud IDE

Usage
  • ide:delete [<applicationUuid>]
  • ide:delete [<applicationAlias>]
  • ide:delete myapp
  • ide:delete abcd1234-1111-2222-3333-0e02b2c3d470

Delete a Cloud IDE

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

ide:info

Print information about a Cloud IDE

Usage
  • ide:info [<applicationUuid>]
  • ide:info [<applicationAlias>]
  • ide:info myapp
  • ide:info abcd1234-1111-2222-3333-0e02b2c3d470

Print information about a Cloud IDE

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

ide:list:app

List available Cloud IDEs belonging to a given application

Usage
  • ide:list:app [<applicationUuid>]
  • ide:list
  • ide:list:app [<applicationAlias>]
  • ide:list:app myapp
  • ide:list:app abcd1234-1111-2222-3333-0e02b2c3d470

List available Cloud IDEs belonging to a given application

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

ide:list:mine

List Cloud IDEs belonging to you

Usage
  • ide:list:mine [<applicationUuid>]
  • ide:list:mine [<applicationAlias>]
  • ide:list:mine myapp
  • ide:list:mine abcd1234-1111-2222-3333-0e02b2c3d470

List Cloud IDEs belonging to you

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

ide:open

Open a Cloud IDE in your browser

Usage
  • ide:open [<applicationUuid>]
  • ide:open [<applicationAlias>]
  • ide:open myapp
  • ide:open abcd1234-1111-2222-3333-0e02b2c3d470

Open a Cloud IDE in your browser

Arguments
applicationUuid

The Cloud Platform application UUID or alias

  • Is required: no
  • Is array: no
  • Default: NULL

push

push:artifact

Build and push a code artifact to a Cloud Platform environment

Usage
  • push:artifact [--dir DIR] [--no-sanitize] [--dry-run] [-u|--destination-git-urls DESTINATION-GIT-URLS] [-b|--destination-git-branch DESTINATION-GIT-BRANCH] [-t|--destination-git-tag DESTINATION-GIT-TAG] [-s|--source-git-tag SOURCE-GIT-TAG] [--] [<environmentId>]
  • push:artifact [<environmentAlias>]
  • push:artifact myapp.dev
  • push:artifact 12345-abcd1234-1111-2222-3333-0e02b2c3d470
  • push:artifact --destination-git-branch=main-build
  • push:artifact --source-git-branch=main-build --destination-git-tag=1.0.0
  • push:artifact --dest-git-url=example@svn-1.prod.hosting.acquia.com:example.git --dest-branch=main-build

This command builds a sanitized deploy artifact by running composer install, removing sensitive files, and committing vendor directories.

Vendor directories and scaffold files are committed to the build artifact even if they are ignored in the source repository.

To run additional build or sanitization steps (e.g. npm install), add a post-install-cmd script to your composer.json file: https://getcomposer.org/doc/articles/scripts.md#command-events

Arguments
environmentId

The Cloud Platform environment ID or alias

  • Is required: no
  • Is array: no
  • Default: NULL
Options
–dir

The directory containing the Drupal project to be pushed

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–no-sanitize

Do not sanitize the build artifact

  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false
–dry-run

Do not push changes to Acquia Cloud

  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Is negatable: no
  • Default: false
–destination-git-urls|-u

The URL(s) of your git repository to which the artifact branch will be pushed

  • Accept value: yes
  • Is value required: yes
  • Is multiple: yes
  • Is negatable: no
  • Default: array ()
–destination-git-branch|-b

The destination branch to push the artifact to

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: NULL
–destination-git-tag|-t