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
Display help for a command
help [--format FORMAT] [--raw] [--] [<command_name>]
The help command displays help for a given command:
/usr/local/bin/acli help list
You can also output the help in other formats by using the –format option:
/usr/local/bin/acli help –format=xml list
To display the list of available commands, please use the list command.
command_name
The output format (txt, xml, json, or md)
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: 'txt'
To output raw command help
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Open Acquia product documentation in a web browser
docs [<product>]
docs acli
Open Acquia product documentation in a web browser
product
List all Acquia Cloud Site Factory commands
acsf:list
acsf
List all Acquia Cloud Site Factory commands
Regenerate ALL users API keys
acsf:api:regenerate-all-keys
For more help, see https://cloudapi-docs.acquia.com/
or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api
for acsf commands.
Regenerate a user’s API key
acsf:api:regenerate-key <user_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
user_id
List audit events
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 100).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “ASC” or “DESC”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The source of the event.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The system name of the module.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The general scope of the changes.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The specific type of changes.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An associated node ID.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The user who made the change.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Get current centralized role management settings.
acsf:roles:get-mgr
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Set the centralized role management settings for a given role.
acsf:roles:set-mgr <factory_role> <site_role>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
factory_role
site_role
Disable the centralized role management settings for a given role.
acsf:roles:disable-mgr <factory_role>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
factory_role
Get list of available stacks.
acsf:info:stacks-find
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Create a new cron job.
acsf:crons:create <name> <cron_command> <interval> <sites_affected> <enabled> <thread_percentage> <stacks>...
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
name
cron_command
interval
sites_affected
enabled
thread_percentage
stacks
Get cron jobs. sites_affected: dev-sites(without custom domains)|prod-sites(with custom domains)|all
acsf:cron:find-jobs [--limit LIMIT] [--page PAGE]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 1000).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Edit a cron job.
acsf:crons:edit <job_id> <name> <cron_command> <interval> <sites_affected> <enabled> <thread_percentage> <stacks>...
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
job_id
name
cron_command
interval
sites_affected
enabled
thread_percentage
stacks
Delete a cron job.
acsf:crons:delete <job_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
job_id
Get cron job
acsf:cron:get-job <job_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
job_id
Get domains
acsf:domains:get <node_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
node_id
Get domain status
acsf:domains:get-status <domain_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
domain_name
Add domain
acsf:domains:add <node_id> <domain_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
node_id
domain_name
Remove domain
acsf:domains:remove <node_id> <domain_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
node_id
domain_name
Backfill the current factory standard domain templates.
acsf:domains:backfill-std
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Get the current factory standard domain templates.
acsf:domains:get-std-templates
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Set the factory standard domain template.
acsf:domains:set-std-templates <template_name> <new_template>...
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
template_name
new_template
Remove the factory standard domain template.
acsf:domains:remove-std-templates <template_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
template_name
List group members
acsf:groups:find-members [--limit LIMIT] [--page PAGE] [--] <group_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
A positive integer (max 1000).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Add members to a group
acsf:groups:add-members <group_id> <uids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
uids
Remove members from a group
acsf:groups:remove-members <group_id> <uids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
uids
Get a group
acsf:groups:get <group_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
Delete a group
acsf:groups:delete <group_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
List groups
acsf:groups:find [--limit LIMIT] [--page PAGE]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer not higher than 100.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create a group
acsf:groups:create [--parent_id PARENT_ID] [--] <group_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_name
The parent group ID, if applicable.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Edit a group
acsf:groups:edit <group_id> <group_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
group_name
Make members group admin
acsf:groups:make-members-admins <group_id> <uids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
uids
Remove group admin from members
acsf:groups:remove-admins <group_id> <uids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
uids
Add site(s) to a site group.
acsf:groups:add-sites <group_id> <site_ids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
site_ids
Remove site(s) from a site group.
acsf:groups:remove-sites <group_id> <site_ids>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
site_ids
List sites in a group.
acsf:groups:find-sites [--limit LIMIT] [--page PAGE] [--] <group_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
group_id
A positive integer (max 1000).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List installation profiles.
acsf:install-profiles:find [--stack_id STACK_ID] [--is_enabled IS_ENABLED]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Get only the profiles on the given stack.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Get only the enabled/disabled profiles.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Enable installation profile.
acsf:install-profiles:enable [--stack_id STACK_ID] [--] <profile_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
profile_name
The installation profile’s stack.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Disable installation profile.
acsf:install-profiles:disable [--stack_id STACK_ID] [--] <profile_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
profile_name
The installation profile’s stack.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Sets the installation profile as default.
acsf:install-profiles:set-default [--stack_id STACK_ID] [--] <profile_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
profile_name
The installation profile’s stack.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List monthly aggregated dynamic request statistics.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
stack_id
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
The sort order direction. Either asc or desc.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
The page number to show in the list.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List monthly dynamic request statistics by domain.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
stack_id
date
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
The sort order direction. Either asc or desc.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The number of domains to be listed. (max 100)
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The page number to show in the list.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Pause/resume task processing
acsf:tasks:pause-all [--reason REASON] [--] <paused>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
paused
Brief explanation for pausing workers.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Pause/resume task processing for a specific task
acsf:tasks:pause <task_id> <paused> <level>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
task_id
paused
level
Check service response
acsf:api:ping
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
List roles
acsf:roles:find [--limit LIMIT] [--page PAGE] [--order ORDER]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 100).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “ASC” or “DESC”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create a role
acsf:roles:create <name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
name
Retrieve a role
acsf:roles:get <role_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
role_id
Delete a role
acsf:roles:delete <role_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
role_id
Update (rename) a role
acsf:roles:update <role_id> <new_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
role_id
new_name
Get the version of the Site Factory
acsf:api:factory-version
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Get current site ownership settings.
acsf:site-owner:get
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Set the site ownership settings.
acsf:site-owner:set <username>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
username
Delete the site ownership settings.
acsf:site-owner:delete
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
List sites
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 1000).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
No value necessary.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Show sites that are incomplete.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Show sites on a specific stack.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Show sites whose domain contains this value.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Show sites whose domain does not contain this value.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Whether to only show sites with custom domains.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
Create a site
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_name
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
The stack id where the site should go.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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 ()
Site details
acsf:sites:get <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
Site delete
acsf:sites:delete <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
Duplicate a site
acsf:sites:duplicate [--exact_copy EXACT_COPY] [--group_ids GROUP_IDS] [--] <site_id> <site_name>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
site_name
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
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 ()
Create a site backup
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
The human-readable description of this backup.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The callback URL, which is invoked upon completion.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
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 ()
List site backups
acsf:sites:find-backups [--limit LIMIT] [--page PAGE] [--] <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
A positive integer (max 100).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Get a temporary site backup URL
acsf:sites:backup-url [--lifetime LIFETIME] [--] <site_id> <backup_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
backup_id
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
Delete a site backup
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
backup_id
The callback URL, which is invoked upon completion.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
Restore a site backup
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
The callback URL, which is invoked upon completion.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
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 ()
Clear a site’s caches
acsf:sites:clear-cache <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
Retrieve available environments
acsf:stage-v2:find-envs
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Start staging process
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
to_env
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
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
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 copying the staged down sites’ files.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Node IDs of sites to deploy.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
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 ()
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 ()
Get service status information
acsf:service-status:get
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Modify service status
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
on, off, or something strtotime accepts
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
on, off, or something strtotime accepts
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
on, off, or something strtotime accepts
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
on, off, or something strtotime accepts
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
on, off, or something strtotime accepts
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
(Internal use only) Get Task class information.
acsf:tasks:find-wip-classes <type>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
type
(Internal use only) Get Task information.
acsf:tasks:get [--limit LIMIT] [--page PAGE] [--status STATUS] [--class CLASS] [--group GROUP]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 100).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
processing, error or not-started
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A WIP class name to filter on.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A WIP group name to filter on.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
(Internal use only) Get Task log information.
acsf:tasks:log [--level LEVEL] [--descendants DESCENDANTS] [--] <task_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
task_id
The minimum status level to display
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Include the logs of all descendant tasks.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Delete tasks from the work pool.
acsf:tasks:delete <task_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
task_id
Terminate tasks in the work pool.
acsf:tasks:terminate <task_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
task_id
Get current task log settings.
acsf:tasks:get-task-log-settings
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Edit current task log settings.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
Reset task log settings.
acsf:tasks:reset-task-log-settings
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
External theme repository deploy key
acsf:themes:key
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Process theme modifications
acsf:themes:process-notifications [--sitegroup_id SITEGROUP_ID]
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
Site external theme refresh
acsf:themes:refresh <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
Set site external theme
acsf:themes:link-vcs [--vcs_url VCS_URL] [--] <site_id> <vcs_path>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
vcs_path
The external theme repository’s url.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Delete site external theme
acsf:themes:unlink-vcs <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
Send a theme notification
acsf:themes:send-notification [--nid NID] [--theme THEME] [--uid UID] [--] <scope> <event>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
scope
event
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
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
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
Transfer the site ownership.
acsf:site-owner:transfer [--username USERNAME] [--email EMAIL] [--force_transfer FORCE_TRANSFER] [--] <site_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
site_id
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
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
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
Start an update
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Either “sites”, “factory”, or “both”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
A VCS ref to deploy to the sites.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A VCS ref to deploy to the Factory.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “code”, “code, db”, or “code, db, registry”
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “code” or “code, db”
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The stack id to release to.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
List updates
acsf:updates:find
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Get update progress
acsf:updates:status <update_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
update_id
Pause an update
acsf:updates:pause <pause>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
pause
List users
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
A positive integer (max 100).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A positive integer.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “ASC” or “DESC”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A comma-separated list of user IDs.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A comma-separated list of role IDs.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “active” or “blocked”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
First uid value to start with.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Last uid value to fetch.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Lowest ‘created’ value (timestamp).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Highest ‘created’ value (timestamp).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Lowest ‘login’ value (timestamp).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Highest ‘login’ value (timestamp).
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Either “active” or “disabled”.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
A comma-separated list of Drupal user fields.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create a user
acsf:users:create [--pass PASS] [--status STATUS] [--roles ROLES] [--] <name> <mail>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
name
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
The user’s status, either 0 or 1.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
Retrieve a user
acsf:users:get [--fields FIELDS] [--] <user_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
user_id
A comma-separated list of fields to retrieve.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Delete a user
acsf:users:delete <user_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
user_id
Update a user
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
user_id
The name of the user.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The email address of the user.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The user’s password.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The user’s status, either 0 or 1.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Single role name, or an array of them.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The user’s TFA status, either 0 or 1.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List deployable refs
acsf:info:vcs-find [--stack_id STACK_ID] [--] <type>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
type
The stack id.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Wip task status
acsf:tasks:status <task_id>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
task_id
List all API commands for the api resource
acsf:api
List all API commands for the api resource
List all API commands for the info resource
acsf:info
List all API commands for the info resource
List all API commands for the roles resource
acsf:roles
List all API commands for the roles resource
List all API commands for the crons resource
acsf:crons
List all API commands for the crons resource
List all API commands for the cron resource
acsf:cron
List all API commands for the cron resource
List all API commands for the domains resource
acsf:domains
List all API commands for the domains resource
List all API commands for the groups resource
acsf:groups
List all API commands for the groups resource
List all API commands for the install-profiles resource
acsf:install-profiles
List all API commands for the install-profiles resource
List all API commands for the page-views resource
acsf:page-views
List all API commands for the page-views resource
List all API commands for the tasks resource
acsf:tasks
List all API commands for the tasks resource
List all API commands for the site-owner resource
acsf:site-owner
List all API commands for the site-owner resource
List all API commands for the sites resource
acsf:sites
List all API commands for the sites resource
List all API commands for the stage-v2 resource
acsf:stage-v2
List all API commands for the stage-v2 resource
List all API commands for the service-status resource
acsf:service-status
List all API commands for the service-status resource
List all API commands for the themes resource
acsf:themes
List all API commands for the themes resource
List all API commands for the updates resource
acsf:updates
List all API commands for the updates resource
List all API commands for the users resource
acsf:users
List all API commands for the users resource
List all API commands
api:list
api
List all API commands
Return the current system health status.
api:system-health-status
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Returns details about your account.
api:accounts:find
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Returns whether your account has access to a specific application permission.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
permission
Returns whether your account is an administrator for an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns whether your account is the owner for an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Marks an application as recently viewed.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Stars an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Removes an application from the user’s starred list.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns a list of Cloud IDEs associated with the current user.
api:accounts:ide-list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Gets a list of all organization admin and team invites that are pending for the current user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of messages associated with the current user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns whether your account is an administrator for an organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Returns whether your account is the owner for an organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Verifies that the supplied password matches the current user’s password.
api:accounts:password-check <password>
api:accounts:password-check "mysupersecretpassword"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
password
Gets a list of SSH keys associated with the current user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Installs a new SSH key for the current user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
label
public_key
Get an SSH key associated with the currently-logged in user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
sshKeyUuid
Deletes an SSH key.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
sshKeyUuid
Returns whether your account is an administrator for a subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Returns whether your account is the owner for a subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Returns whether your account has access to a specific team permission.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
permission
Returns whether your account is an administrator for a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
Returns whether your account is the owner for a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
Returns a list of metadata for API access tokens tied to your account.
api:accounts:tokens-list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Creates an API access token tied to your account.
api:accounts:token-create <label>
api:accounts:token-create "API token for My App"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
label
Return details about a specific token.
api:accounts:token-list <tokenUuid>
api:accounts:token-list 882f3258-2fe9-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
tokenUuid
Revokes an access token.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
tokenUuid
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
Return a list of agreements.
api:agreements:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Return a specific agreement by a provided UUID.
api:agreements:find <agreementUuid>
api:agreements:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
agreementUuid
Accepts a legal agreement by UUID.
api:agreements:accept <agreementUuid>
api:agreements:accept da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
agreementUuid
Declines a legal agreement by UUID.
api:agreements:decline <agreementUuid>
api:agreements:decline da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
agreementUuid
Returns a list of users invited to action this agreement.
api:agreements:invitees-list <agreementUuid>
api:agreements:invitees-list da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
agreementUuid
Return a list of applications the current user has access to.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Renames an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
The new name of the application.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return application artifacts.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific artifact.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
artifactId
Return application branches and release tags.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
Returns a list database names for the application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Creates a database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
name
Drops (deletes) a database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
name
Erases (truncates) a database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
name
Returns a list of email domains associated with the application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Associates an email domain with an Application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
domainRegistrationUuid
Disassociates an email domain with an Application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
domainRegistrationUuid
Returns a list of Cloud IDEs associated with this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns a list of messages associated with this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of notifications associated with this application by its UUID.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of permissions the user has for this application by its UUID.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns a traversal endpoint for search entities for the application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns a collection of search configuration sets for an application
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Creates a search configuration set for an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
archive
Returns a search configuration set for an application
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
configurationSetId
Removes and deletes a specific search configuration set from an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
configurationSetId
Returns available settings for this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns the remote administration settings for this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Modifies the remote administration settings for an application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
update_mode
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
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
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
The environment id of the environment to deploy to.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
Whether to copy files from production to testing environment.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Whether to copy database from production to testing environment.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
Returns a list of application tags associated with this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Returns a list of teams associated with this application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Retrieves traversal links for detailed metrics on usage (views and visits) of your application.
api:applications:usage-links <applicationUuid>
api:applications:usage-links da1c0a8e-ff69-45db-88fc-acd6d2affbb7
api:applications:usage-links myapp
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Retrieves aggregate usage data for an application, filterable by views or visits and by environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
Retrieves usage data (views or visits) for an application, broken down by environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
Retrieves aggregate usage metric data (views or visits) for an application..
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
usageMetric
applicationUuid
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
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
Retrieves views data for an application, broken down by environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
Retrieves visits data for an application, broken down by environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
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
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
Return a list of Drupal distributions.
api:distributions:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Return details about a specific Drupal distribution.
api:distributions:find <name>
api:distributions:find drupal8
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
name
Returns a list of environments within this application by its UUID.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Add a new continuous delivery environment to an application by the application UUID.
api:applications:environment-create <applicationUuid> <label> <branch> <databases>...
api:applications:environment-create da1c0a8e-ff69-45db-88fc-acd6d2affbb7 "CD label" "my-feature-branch" "database1" "database2"
api:applications:environment-create myapp "CD label" "my-feature-branch" "database1" "database2"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
label
branch
databases
Return application features.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
applicationUuid
Return details about a specific environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Modifies configuration settings for an environment.
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] [--memcached_limit MEMCACHED_LIMIT] [--] <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" --memcached_limit="128"
api:environments:update myapp.dev --memory_limit="192" --apcu="8" --max_execution_time="10" --max_post_size="256" --max_input_vars="1000" --memcached_limit="128"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
The PHP or Node version.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Limits PHP request memory usage in megabytes.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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 shared memory size per web server.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Sets PHP Opcache key count per server.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Limits PHP request time in seconds.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Sets the PHP limit on POST body size.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Limits the number of various request items in PHP.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Sets the maximum amount of memory in MB that can be allocated to memcached. Only available on Acquia Cloud Next.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Deletes a CD environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Clears the caches for one or more domains attached to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
domains
Create a Migrate Environment using the provided environment as its source.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
label
Indicates whether or not to copy configurations.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Promote a Migrate Environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
target
Refreshes a Migrate Environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Deploys an artifact to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
artifact_id
Return a list of runtimes.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns the CDN status for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Enables a CDN for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Disables a CDN for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns a list of Cloud Actions.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Modifies an existing list of Cloud Actions.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cloud-actions
Disables Cloud Actions.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Enables Cloud Actions.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Resets Cloud Actions.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Deploys code to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
source
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
An optional array of Cloud Actions.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
Switches code on this environment to a different branch or release tag.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
branch
An optional array of Cloud Actions.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
Imports a site to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
url
The name of the distribution being installed.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return environment cron jobs.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Creates a scheduled job with cron.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cron_command
frequency
label
Return details about a specific cron job.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cronId
Modify an existing scheduled job.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cronId
The command to run.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
The label for this cron.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Deletes a cron job.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cronId
Enables a cron job.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cronId
Disables a cron job.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
cronId
Returns a list of databases.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Copies a database to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
name
source
Return details about a specific database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
Returns PHP configuration details for this database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
Returns a list of backups.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
(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
(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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create a backup.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
Return details about a specific backup.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
backupId
Deletes a database backup.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
backupId
Downloads the database backup file.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
backupId
Restores this backup to the appropriate environment’s database.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
databaseName
backupId
Returns DNS configuration details for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns a list of domains.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Adds a domain to the environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
The domain name to add.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific domain.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
domain
Removes the domain from this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
domain
Clears the caches for the specified domain.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
domain
Returns details about the domain.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
domain
Return a list of Web EIPs.
api:environments:eips-list <environmentId>
api:environments:eips-list 12-d314739e-296f-11e9-b210-d663bd873d93
api:environments:eips-list myapp.dev
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns the status of Platform Email for an Environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Disables email for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Enables email for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Copies files to this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
The ID of the environment to copy files from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of log files for this environment available for download.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Downloads the log file.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logType
Creates a log file snapshot.
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-28T22:45:21+00:00" --to="2021-01-29T23:55:21+00:00"
api:environments:log-create myapp.dev php-error --from="2021-01-28T22:45:21+00:00" --to="2021-01-29T23:55:21+00:00"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logType
An ISO-8601 formatted date retrieve results from. Date ranges are only supported on Acquia Cloud Next.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An ISO-8601 formatted date retrieve results to. Date ranges are only supported on Acquia Cloud Next.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a logstream url and metadata.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Disable Live Development on this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Indicates whether uncommitted changes should be discarded or not.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Enable Live Development on this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns a collection of log forwarding destinations for this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Creates a log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
label
consumer
credentials
sources
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
Returns the specified log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logForwardingDestinationUuid
Updates an environment’s log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logForwardingDestinationUuid
consumer
The human-friendly identifier of the destination.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Credential information.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
The list of log sources to forward.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
Deletes the specified log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logForwardingDestinationUuid
Disables the specified log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logForwardingDestinationUuid
Enables the specified log forwarding destination.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
logForwardingDestinationUuid
Does not return any data. Allows traversal to metrics groups endpoints.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Does not return any data. Allows traversal to StackMetrics endpoints.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns StackMetrics data for the metrics specified in the filter paramater (e.g., apache-access, web-cpu).
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
filter
from
An ISO-8601 formatted date retrieve results to.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
Retrieves traversal links for an environment’s usage data.
api:environments:usage-links <environmentId>
api:environments:usage-links 12-d314739e-296f-11e9-b210-d663bd873d93
api:environments:usage-links myapp.dev
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Retrieves usage data for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
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
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
Retrieves usage metric data for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
usageMetric
environmentId
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
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
Disables production mode for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Enables production mode for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns a traversal endpoint for search entities for the environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns a collection of search indexes for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Creates a search index for an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
database_role
A configuration set ID to assign to the index.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a search configuration set for an application
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
indexId
Updates a search index on an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
indexId
The configuration set ID to update to.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Removes and deletes a specific search index from an environment
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
indexId
Returns a list of servers.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific server.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
Modifies configuration settings for a server.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
The size (in MB) of memcache on this server.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Reboots a server.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
Relaunches a server.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
Suspends a server.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
Upgrades a server from “precise” to “xenial”.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
serverId
Provides links to environment settings.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Returns the SSL settings for this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Return a list of SSL certificates.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
Install an SSL certificate.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificate
private_key
Must be set to true for legacy certificates.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The CA intermediary certificates.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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
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
Returns a specific certificate by certificate id.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Deletes a specific certificate by its ID.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Activates an SSL certificate.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Deactivates an active SSL certificate.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Returns the certificate signing request for the certificate specified by id.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Generates a certificate signing request (CSR) for one or more domains.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
country
state
locality
organization
organizational_unit
common_name
The Subject Alternate Names (SNI only) for CSR generation.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
Deletes the certificate signing request.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
certificateId
Returns a list of environment variables associated with this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Adds a new environment variable to an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
The name of the environment variable to add.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The value of the environment variable to add.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Get an environment variable associated with this environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
environmentVariableName
Removes an environment variable from an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
environmentVariableName
Updates an environment variable on an environment.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
environmentId
environmentVariableName
name
value
Returns Cloud IDE info.
api:ide:find <ideUuid>
api:ide:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
ideUuid
De-provisions a specific Cloud IDE.
api:ide:delete <ideUuid>
api:ide:delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
ideUuid
Returns a list of identity providers for a user.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a specific identity provider by UUID.
api:identity-providers:find <identityProviderUuid>
api:identity-providers:find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
identityProviderUuid
Modifies an identity provider by its UUID.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
identityProviderUuid
The new identity provider label.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The entity ID of the identity provider
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The URL of the SSO identity provider.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The PEM-encoded X.509 certificate.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Deletes a specific identity provider by its UUID.
api:identity-providers:delete <identityProviderUuid>
api:identity-providers:delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
identityProviderUuid
Enables an identity provider by its UUID.
api:identity-providers:enable <identityProviderUuid>
api:identity-providers:enable da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
identityProviderUuid
Disables an identity provider by its UUID.
api:identity-providers:disable <identityProviderUuid>
api:identity-providers:disable da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
identityProviderUuid
Returns details about an invitation.
api:invites:find <token>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
token
Cancels an invitation.
api:invites:cancel <token>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
token
Accepts an invite.
api:invites:accept <token>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
token
Declines an invite.
api:invites:decline <token>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
token
Resend an invite.
api:invites:resend <token>
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
token
Dismisses a message.
api:messages:dismiss <messageUuid>
api:messages:dismiss da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
messageUuid
Follows an in-product message link.
api:messages:follow <messageUuid>
api:messages:follow da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
messageUuid
Returns a single notification.
api:notifications:find <notificationUuid>
api:notifications:find 2343b683-b194-4217-982a-6a95c72ad9a8
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
notificationUuid
Does not return any data. Allows traversal of options groups endpoints.
api:options:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Displays the various CD Environment size options.
api:options:cde-sizes-list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Does not return any data. Allows traversal of options groups endpoints.
api:options:log-forwarding
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Displays available log forwarding sources.
api:options:log-forwarding-source-list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Displays available log forwarding consumers.
api:options:log-forwarding-consumer-list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Displays the various color options.
api:colors:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Return a list of organizations.
api:organizations:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Creates a new organization.
api:organizations:create <name>
api:organizations:create "My new organization"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
name
Return details about a specific organization.
api:organizations:find <organizationUuid>
api:organizations:find 1e7efab9-0fac-4a2c-ad94-61efc78623ba
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Renames an organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
name
Deletes a specific organization by its UUID.
api:organizations:delete <organizationUuid>
api:organizations:delete 1e7efab9-0fac-4a2c-ad94-61efc78623ba
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Changes the organization owner.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
user_uuid
Removes your account from an organization.
api:organizations:leave <organizationUuid>
api:organizations:leave 1e7efab9-0fac-4a2c-ad94-61efc78623ba
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Returns a list of organization administrators.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns the user profile of this organization administrator.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
userUuid
Removes the user from the list of administrators for the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
userUuid
Gets a list of invitations of administrators for this organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
ISO-8601 date/time of invite create date/time.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Invites a user to be an administrator in this organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Returns a list of applications that belong to the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns an identity provider for an organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
Returns a list of all organization members.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns the user profile of this organization member.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
userUuid
Removes the member from the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
userUuid
Returns a list of applications that an organization member has access to.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
userUuid
Returns a list of notifications associated with this organization by its UUID.
api:organizations:notification-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <organizationUuid>
api:organizations:notification-list 1e7efab9-0fac-4a2c-ad94-61efc78623ba --sort="field1,-field2" --limit="10" --offset="10"
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of all the canonical roles within the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
ISO-8601 date/time of invite create date/time.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Creates a role.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
name
permissions
The description of the new role.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of subscriptions that belong to the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
ISO-8601 date/time of invite create date/time.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Gets a list of member invitations for all teams in this organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of teams associated with the organization.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Creates a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
organizationUuid
name
Return a list of permissions.
api:permissions:list
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Return details about a specific role.
api:tps:role-find <roleUuid>
api:tps:role-find da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
roleUuid
Deletes a specific role by its UUID.
api:tps:roles-delete <roleUuid>
api:tps:roles-delete da1c0a8e-ff69-45db-88fc-acd6d2affbb7
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
roleUuid
Updates a role.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
roleUuid
The new name of the role.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The new description of the role.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An array of the permissions associated with the role.
Accept value: yes
Is value required: yes
Is multiple: yes
Is negatable: no
Default: array ()
Return a list of subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific subscription.
api:subscriptions:find <subscriptionUuid>
api:subscriptions:find 0f3ad33e-2fe4-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Modifies a subscription.
api:subscriptions:update [--name NAME] [--] <subscriptionUuid>
api:subscriptions:update 0f3ad33e-2fe4-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
The new subscription name.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns the Application Performance Monitoring service type associated with the subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
apmType
Enables New Relic Pro APM license for all applications on a subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
apmType
Provides a list of applications that are a part of the subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a list of Domains registered with this subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Registers a Domain with this subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
The domain name to add.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Returns a speicific Domain registered with this subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
domainRegistrationUuid
Unregisters a Domain registered with this subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
domainRegistrationUuid
Triggers re-verification and update to the domain verification status.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
domainRegistrationUuid
Provides a list of entitlements that are a part of the subscription.
api:subscriptions:entitlements-list <subscriptionUuid>
api:subscriptions:entitlements-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Returns a list of Cloud IDEs associated with this subscription.
api:subscriptions:ide-list <subscriptionUuid>
api:subscriptions:ide-list 0f3ad33e-2fe4-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Retrieves traversal links for a subscription’s usage data.
api:subscriptions:usage-links <subscriptionUuid>
api:subscriptions:usage-links 0f3ad33e-2fe4-11e9-b210-d663bd873d93
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Retrieves aggregate usage data for a subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
Retrieves usage data for a subscription, broken down by application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
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
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
Retrieves aggregate usage metric data for a subscription.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
usageMetric
subscriptionUuid
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
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
Retrieves views data for a subscription, broken down by application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
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
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
Retrieves visits data for a subscription, broken down by application.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
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
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
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
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
Provides a list of Shield ACL rules.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Creates a Shield ACL rule.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
The description of the new Shield ACL rule.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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 ()
Returns the specified Shield ACL rule.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
shieldAclUuid
Updates a Shield ACL rule.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
shieldAclUuid
The description of the new Shield ACL rule.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
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 ()
Deletes a Shield ACL rule.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
shieldAclUuid
Resets Shield ACL rules to default settings.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
subscriptionUuid
Return teams the current user has access to.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
ISO-8601 date/time of invite create date/time.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Return details about a specific team.
api:tps:team-find <teamUuid>
api:tps:team-find 3eef5d81-62f4-429c-aa94-e17d05ab4740
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
Change the name of a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
The new name of the team.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Deletes a specific team by its UUID.
api:tps:team-delete <teamUuid>
api:tps:team-delete 3eef5d81-62f4-429c-aa94-e17d05ab4740
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
Removes the current user from a team.
api:tps:user-leave <teamUuid>
api:tps:user-leave 3eef5d81-62f4-429c-aa94-e17d05ab4740
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
Returns a list of applications this team has access to.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Adds an application to this team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
uuid
Removes the application from this team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
applicationUuid
Returns a list of invitations to this team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
ISO-8601 date/time of invite create date/time.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Invites a user to join a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
roles
Returns a list of team members.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
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
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
The maximum number of items to return.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
An integer to signify the offset to paginate from.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Grant team roles to a member.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
userUuid
roles
Remove a user from a team.
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/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
teamUuid
userUuid
List all API commands for the accounts resource
api:accounts
List all API commands for the accounts resource
List all API commands for the agreements resource
api:agreements
List all API commands for the agreements resource
List all API commands for the applications resource
api:applications
List all API commands for the applications resource
List all API commands for the distributions resource
api:distributions
List all API commands for the distributions resource
List all API commands for the environments resource
api:environments
List all API commands for the environments resource
List all API commands for the ide resource
api:ide
List all API commands for the ide resource
List all API commands for the identity-providers resource
api:identity-providers
List all API commands for the identity-providers resource
List all API commands for the invites resource
api:invites
List all API commands for the invites resource
List all API commands for the messages resource
api:messages
List all API commands for the messages resource
List all API commands for the notifications resource
api:notifications
List all API commands for the notifications resource
List all API commands for the options resource
api:options
List all API commands for the options resource
List all API commands for the colors resource
api:colors
List all API commands for the colors resource
List all API commands for the organizations resource
api:organizations
List all API commands for the organizations resource
List all API commands for the permissions resource
api:permissions
List all API commands for the permissions resource
List all API commands for the tps resource
api:tps
List all API commands for the tps resource
List all API commands for the subscriptions resource
api:subscriptions
List all API commands for the subscriptions resource
Opens your browser to view a given Cloud application
app:open [<applicationUuid>]
open
o
app:open [<applicationAlias>]
app:open myapp
app:open prod:myapp
app:open abcd1234-1111-2222-3333-0e02b2c3d470
Opens your browser to view a given Cloud application
applicationUuid
Associate your project with a Cloud Platform application
app:link [<applicationUuid>]
link
app:link [<applicationAlias>]
app:link myapp
app:link prod:myapp
app:link abcd1234-1111-2222-3333-0e02b2c3d470
Associate your project with a Cloud Platform application
applicationUuid
Tail the logs from your environments
app:log:tail [<environmentId>]
tail
log:tail
app:log:tail [<environmentAlias>]
app:log:tail myapp.dev
app:log:tail prod:myapp.dev
app:log:tail 12345-abcd1234-1111-2222-3333-0e02b2c3d470
Tail the logs from your environments
environmentId
Create a new Drupal or Next.js project
app:new:local [<directory>]
new
Create a new Drupal or Next.js project
directory
Wait for a task to complete
app:task-wait <notification-uuid>
app:task-wait acli app:task-wait "$(api:environments:domain-clear-caches [environmentId] [domain])"
This command will accepts either a notification uuid as an argument or else a json string passed through standard input. The json string must contain the _links->notification->href property.
notification-uuid
Remove local association between your project and a Cloud Platform application
app:unlink
unlink
Remove local association between your project and a Cloud Platform application
Register your Site Factory API key and secret to use API functionality
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
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
The key for your Site Factory user
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The URL of your factory. E.g., https://www.example.com
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Remove your Site Factory key and secret from your local machine.
auth:acsf-logout
Remove your Site Factory key and secret from your local machine.
Register your Cloud API key and secret to use API functionality
auth:login [-k|--key KEY] [-s|--secret SECRET]
login
Register your Cloud API key and secret to use API functionality
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Remove Cloud API key and secret from local machine.
auth:logout
logout
Remove Cloud API key and secret from local machine.
Change the PHP version in Code Studio
codestudio:php-version [--gitlab-token GITLAB-TOKEN] [--gitlab-project-id GITLAB-PROJECT-ID] [--gitlab-host-name GITLAB-HOST-NAME] [--] <php-version> [<applicationUuid>]
codestudio:php-version 8.1 myapp
codestudio:php-version 8.1 abcd1234-1111-2222-3333-0e02b2c3d470
codestudio:php-version [<applicationAlias>]
codestudio:php-version myapp
codestudio:php-version prod:myapp
codestudio:php-version abcd1234-1111-2222-3333-0e02b2c3d470
Change the PHP version in Code Studio
php-version
applicationUuid
The GitLab personal access token that will be used to communicate with the GitLab instance
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The project ID (an integer) of the GitLab project to configure.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The GitLab hostname.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create and/or configure a new Code Studio project for a given Acquia Cloud application
codestudio:wizard [--key KEY] [--secret SECRET] [--gitlab-token GITLAB-TOKEN] [--gitlab-project-id GITLAB-PROJECT-ID] [--gitlab-host-name GITLAB-HOST-NAME] [--] [<applicationUuid>]
cs:wizard
codestudio:wizard [<applicationAlias>]
codestudio:wizard myapp
codestudio:wizard prod:myapp
codestudio:wizard abcd1234-1111-2222-3333-0e02b2c3d470
Create and/or configure a new Code Studio project for a given Acquia Cloud application
applicationUuid
The Cloud Platform API token that Code Studio will use
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The Cloud Platform API secret that Code Studio will use
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The GitLab personal access token that will be used to communicate with the GitLab instance
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The project ID (an integer) of the GitLab project to configure.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The GitLab hostname.
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Configure Platform email for one or more applications
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.
subscriptionUuid
Print information related to Platform Email set up in a subscription.
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.
subscriptionUuid
Copy all cron tasks from one Acquia Cloud Platform environment to another
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
source_env
dest_env
Create a new Continuous Delivery Environment (CDE)
env:create <label> [<branch> [<applicationUuid>]]
env:create [<applicationAlias>]
env:create myapp
env:create prod:myapp
env:create abcd1234-1111-2222-3333-0e02b2c3d470
Create a new Continuous Delivery Environment (CDE)
label
branch
applicationUuid
Delete a Continuous Delivery Environment (CDE)
env:delete [<environmentId>]
env:delete [<environmentAlias>]
env:delete myapp.dev
env:delete prod:myapp.dev
env:delete 12345-abcd1234-1111-2222-3333-0e02b2c3d470
Delete a Continuous Delivery Environment (CDE)
environmentId
Makes one environment identical to another in terms of code, database, files, and configuration.
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.
source-environment
destination-environment
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Create a Cloud IDE
ide:create [--label LABEL] [--] [<applicationUuid>]
ide:create [<applicationAlias>]
ide:create myapp
ide:create prod:myapp
ide:create abcd1234-1111-2222-3333-0e02b2c3d470
Create a Cloud IDE
applicationUuid
The label for the IDE
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Delete a Cloud IDE
ide:delete [<applicationUuid>]
ide:delete [<applicationAlias>]
ide:delete myapp
ide:delete prod:myapp
ide:delete abcd1234-1111-2222-3333-0e02b2c3d470
Delete a Cloud IDE
applicationUuid
Print information about a Cloud IDE
ide:info [<applicationUuid>]
ide:info [<applicationAlias>]
ide:info myapp
ide:info prod:myapp
ide:info abcd1234-1111-2222-3333-0e02b2c3d470
Print information about a Cloud IDE
applicationUuid
List available Cloud IDEs belonging to a given application
ide:list:app [<applicationUuid>]
ide:list
ide:list:app [<applicationAlias>]
ide:list:app myapp
ide:list:app prod:myapp
ide:list:app abcd1234-1111-2222-3333-0e02b2c3d470
List available Cloud IDEs belonging to a given application
applicationUuid
List Cloud IDEs belonging to you
ide:list:mine [<applicationUuid>]
ide:list:mine [<applicationAlias>]
ide:list:mine myapp
ide:list:mine prod:myapp
ide:list:mine abcd1234-1111-2222-3333-0e02b2c3d470
List Cloud IDEs belonging to you
applicationUuid
Open a Cloud IDE in your browser
ide:open [<applicationUuid>]
ide:open [<applicationAlias>]
ide:open myapp
ide:open prod:myapp
ide:open abcd1234-1111-2222-3333-0e02b2c3d470
Open a Cloud IDE in your browser
applicationUuid
Build and push a code artifact to a Cloud Platform environment
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 prod: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
environmentId
The directory containing the Drupal project to be pushed
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Do not sanitize the build artifact
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Do not push changes to Acquia Cloud
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
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 ()
The destination branch to push the artifact to
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The destination tag to push the artifact to. Using this option requires also using the –source-git-tag option
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The source tag from which to create the tag artifact
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List all aliases for the Cloud Platform environments
remote:aliases:list [<applicationUuid>]
aliases
sa
remote:aliases:list [<applicationAlias>]
remote:aliases:list myapp
remote:aliases:list prod:myapp
remote:aliases:list abcd1234-1111-2222-3333-0e02b2c3d470
List all aliases for the Cloud Platform environments
applicationUuid
Download Drush aliases for the Cloud Platform
remote:aliases:download [--destination-dir DESTINATION-DIR] [--all] [--] [<applicationUuid>]
remote:aliases:download [<applicationAlias>]
remote:aliases:download myapp
remote:aliases:download prod:myapp
remote:aliases:download abcd1234-1111-2222-3333-0e02b2c3d470
Download Drush aliases for the Cloud Platform
applicationUuid
The directory to which aliases will be downloaded
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Download the aliases for all applications that you have access to, not just the current one.
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Run a Drush command remotely on a application’s environment
remote:drush <alias> [<drush_command>...]
drush
dr
remote:drush <app>.<env> -- <command>
remote:drush myapp.dev -- uli 1
remote:drush myapp.dev -- status --fields=db-status
Pleases pay close attention to the argument syntax! Note the usage of – to separate the drush command arguments and options.
alias
drush_command
Use SSH to open a shell or run a command in a Cloud Platform environment
remote:ssh <alias> [<ssh_command>...]
ssh
remote:ssh myapp.dev # open a shell in the myapp.dev environment
remote:ssh myapp.dev -- ls -al # list files in the myapp.dev environment and return
Use SSH to open a shell or run a command in a Cloud Platform environment
alias
ssh_command
Clears local Acquia CLI caches
self:clear-caches
cc
cr
Clears local Acquia CLI caches
List commands
self:list [--raw] [--format FORMAT] [--short] [--] [<namespace>]
list
The self:list command lists all commands:
/usr/local/bin/acli self:list
You can also display the commands for a specific namespace:
/usr/local/bin/acli self:list test
You can also output the information in other formats by using the –format option:
/usr/local/bin/acli self:list –format=xml
It’s also possible to get raw list of commands (useful for embedding command runner):
/usr/local/bin/acli self:list –raw
namespace
To output raw command list
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
The output format (txt, xml, json, or md)
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: 'txt'
To skip describing commands’ arguments
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Toggle anonymous sharing of usage and performance data
self:telemetry:toggle
telemetry
Toggle anonymous sharing of usage and performance data
Disable anonymous sharing of usage and performance data
self:telemetry:disable
telemetry:disable
Disable anonymous sharing of usage and performance data
Enable anonymous sharing of usage and performance data
self:telemetry:enable
telemetry:enable
Enable anonymous sharing of usage and performance data
Updates Acquia CLI to the latest version.
self:update [--stable] [--preview] [--compatible] [--] [<version_constraint>]
update
self-update
The self-update command checks github for newer versions of Acquia CLI and if found, installs the latest.
version_constraint
Use stable releases (default)
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Preview unstable (e.g., alpha, beta, etc.) releases
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Stay on current major version
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Create an SSH key on your local machine
ssh-key:create [--filename FILENAME] [--password PASSWORD]
Create an SSH key on your local machine
The filename of the SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The password for the SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Create an SSH key on your local machine and upload it to the Cloud Platform
ssh-key:create-upload [--filename FILENAME] [--password PASSWORD] [--no-wait]
Create an SSH key on your local machine and upload it to the Cloud Platform
The filename of the SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The password for the SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Don’t wait for the SSH key to be uploaded to the Cloud Platform
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false
Delete an SSH key
ssh-key:delete [-uuid|--cloud-key-uuid CLOUD-KEY-UUID]
Delete an SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Print information about an SSH key
ssh-key:info [--fingerprint FINGERPRINT]
Print information about an SSH key
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
List your local and remote SSH keys
ssh-key:list
List your local and remote SSH keys
Upload a local SSH key to the Cloud Platform
ssh-key:upload [--filepath FILEPATH] [--label LABEL] [--no-wait]
Upload a local SSH key to the Cloud Platform
The filepath of the public SSH key to upload
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
The SSH key label to be used with the Cloud Platform
Accept value: yes
Is value required: yes
Is multiple: no
Is negatable: no
Default: NULL
Don’t wait for the SSH key to be uploaded to the Cloud Platform
Accept value: no
Is value required: no
Is multiple: no
Is negatable: no
Default: false