Site Factory REST API

The Site Factory REST API allows developers to interact with their Site Factory platform.

API Overview

API functions are listed below, first summarized by category, then followed with complete documentation including parameters, return values, and an example curl command.

Status

Sites

Site collections

Groups

Themes

Domains

User

Check service response

Checks whether the API is responding.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/ping' \
    -v -u {user_name}:{api_key}

Example response

  {
    "message": "pong",
    "server_time": "2014-02-16T20:04:12-06:00"
  }

Get service status information

Get a service status report.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/status' \
    -v -u {user_name}:{api_key}

Example response

  {
    "site_creation": "Disabled",
    "site_duplication": "Enabled",
    "domain_management": "Disabled until 2014-02-14T11:52:17-05:00",
    "bulk_operations": "Disabled until 2014-02-14T11:52:17-05:00"
  }

Modify service status

Modify the status of the services.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/status' \
    -X PUT -d '{"all": "on"}' \
    -H 'Content-Type: application/json' \
    -v -u {user_name}:{api_key}

Example response

  {
    "site_creation": "",
    "site_duplication": "2022-02-17T05:06:55-08:00",
    "domain_management": "",
    "bulk_operations": "2022-02-17T05:06:55-08:00"
  }

Request parameters

List sites

Gets a list of sites.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites?limit=20&page=2' \
    -v -u {user_name}:{api_key}

Example response

  {
    "count": 111,
    "sites": [
      {
        "id": 191,
        "created": 1616611353,
        "owner": "John Drupal",
        "site": "site1",
        "db_name": "bdpref191",
        "stack_id": 1,
        "domain": "domain1.site-factory.com",
        "groups": [
          91
        ],
        "site_collection": 176,
        "is_primary": true
      },
      {
        "id": 196,
        "created": 1616611353,
        "owner": "John Drupal",
        "site": "site2",
        "db_name": "bdpref196",
        "stack_id": 2,
        "domain": "domain2.site-factory.com",
        "groups": [
          91,
          105
        ],
        "site_collection": false,
        "is_primary": true
      }
    ]
  }

Request parameters

Site details

Get detailed information about a site.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 123,
    "created": 1397483647,
    "owner": "John Drupal",
    "site": "site1",
    "stack_id": 1,
    "db_name": "bdpref196",
    "domains": [
      "domain1.site-factory.com",
      "domain2.site-factory.com"
    ],
    "groups": [
      91
    ],
    "part_of_collection": true,
    "is_primary": true,
    "collection_id": 241,
    "collection_domains": [
      "domain241.example.com",
      "anotherdomain.com"
    ],
    "external_theme": {
      "vcs_url": "git@github.com:username\/drupal-theme-repo.git",
      "vcs_path": "master"
    }
  }

Request parameters

Create a site

Create a new site.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_name": "mysite"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 191,
    "site": "site1",
    "domains": [
      "mysite.site-factory.com"
    ],
    "task_id": 12345
  }

Request parameters

Site delete

Delete a site.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123' \
    -X DELETE -v -u {user_name}:{api_key}

Example response

  {
    "id": 123,
    "owner": "johnsmith",
    "site": "unicorns",
    "time": "1970-01-01T01:02:03+00:00",
    "task_id": 16
  }

Request parameters

Duplicate a site

Duplicate a site.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/duplicate' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_name": "mysite2", "exact_copy": true}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 183,
    "site": "mysite2"
  }

Request parameters

Create a site backup

Create a site backup.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/backup' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"label": "Weekly", "callback_url": "http://mysite.com", "callback_method": "GET"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "task_id": 183
  }

Request parameters

List site backups

List site backups.

Note that the results are sorted from newest backup to oldest.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/backups?limit=20&page=2' \
    -v -u {user_name}:{api_key}

Example response

  {
    "backups": [
      {
        "id": 6,
        "nid": 123,
        "status": 1,
        "uid": 16,
        "timestamp": 1415044083,
        "bucket": "sitefactorybackups",
        "directory": "oldschool",
        "file": "oldschool_91_1415044083.tar.gz",
        "label": "Weekly",
        "componentList": [
          "codebase",
          "database",
          "public files",
          "private files",
          "themes"
        ],
        "complete": true
      },
      {
        "id": 1,
        "nid": 123,
        "status": 1,
        "uid": 16,
        "timestamp": 1415042116,
        "bucket": "sitefactorybackups",
        "directory": "oldschool",
        "file": "oldschool_91_1415042116.tar.gz",
        "label": "Monthly",
        "componentList": [
          "codebase",
          "database",
          "public files",
          "private files",
          "themes"
        ],
        "complete": false
      }
    ]
  }

Request parameters

Get a temporary site backup URL

Get temporary site backup URL.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/backups/101/url?lifetime=300' \
    -v -u {user_name}:{api_key}

Example response

  {
    "url": "https:\/\/s3.amazonaws.com\/sitefactorybackups\/site\/backup1_101_1415643727.tar.gz?AWSAccessKeyId=AKIAINAAC2EGOVCRW4WA\u0026Expires=1415713064\u0026Signature=pWucd8b6T%2FqzoNewXH6EuTyIr1g%3D",
    "lifetime": 300
  }

Request parameters

Delete a site backup

Delete a site backup.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/backups/101' \
    -X DELETE -H 'Content-Type: application/json' \
    -d '{"callback_url": "http://mysite.com", "callback_method": "GET"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "task_id": 16
  }

Request parameters

Restore a site backup

Restore a site backup.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/restore' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"target_site_id": 456, "backup_id": 789, "callback_url": "http://mysite.com", "callback_method": "GET"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "task_id": 1024
  }

Request parameters

Clear a site's caches

Clear Drupal and Varnish caches for a site.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/123/cache-clear' \
    -X POST -H 'Content-Type: application/json' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id" : 123,
    "time" : "2017-05-04T09:25:26+00:00",
    "task_ids": {
      "drupal_cache_clear" : 1234,
      "varnish_cache_clear" : 1234
    }
  }

Request parameters

Site external theme refresh

Refreshes the site's themes from the external theme repository.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/121/external-theme-refresh' \
    -X POST -H 'Content-Type: application/json' \
    -v -u {user_name}:{api_key}

Example response

  {
     "id": 121,
     "accepted": true,
     "time": "2024-05-11T18:15:19+00:00"
  }

Request parameters

Set site external theme

Sets the site's external theme data.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/121/external-theme' \
    -X PUT -H 'Content-Type: application/json' \
    -d '{"vcs_url": "git@github.com:user/repo.git", "vcs_path": "tag2"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 121,
    "vcs_url": "git@github.com:user\/repo.git",
    "vcs_path": "master",
    "time": "2020-01-09T15:57:24+00:00"
  }

Request parameters

Delete site external theme

Deletes the site's external theme data.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/sites/121/external-theme' \
    -v -u {user_name}:{api_key} -X DELETE \
    -H 'Content-Type: application/json'

Example response

  {
     "id": 121,
     "accepted": true,
     "time": "2024-05-11T18:15:19+00:00"
  }

Request parameters

Transfer the site ownership.

Transfer the site ownership.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/site-ownership/123' \
    -v -u {user_name}:{api_key} -X POST \
    -H 'Content-Type: application/json' \
    -d '{"username": "john.doe"}'

Example response

  {
    "message" : "To transfer your site, please follow the instructions in the e-mail that was sent to site-owner@email.com"
  }

Request parameters

List site collections

Gets a list of site collections.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections?limit=20&page=2' \
    -v -u {user_name}:{api_key}

Example response

  {
     "count": 111,
     "time" : "2016-11-25T13:18:44+00:00",
     "collections": [
       {
         "id": 196,
         "name": "collection2",
         "internal_domain": "domain1.site-factory.com",
         "primary_site": 220,
         "site_count": 2,
         "groups": [
            91
         ]
       }
     ]
  }

Request parameters

Site collection details

Get detailed information about a site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections/123' \
    -v -u {user_name}:{api_key}

Example response

  {
   "id": 261,
   "time": "2016-11-25T13:18:44+00:00",
   "created": 1489075420,
   "owner": "admin",
   "name": "collection1",
   "internal_domain": "collection1.site-factory.com",
   "external_domains": [
     "domain1.site-factory.com"
   ],
   "groups": [
     91
   ],
   "sites": [
     236,
     231
   ],
   "primary_site": 236
 }

Request parameters

Create a site collection

Create a new site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"name": "mycollection", "site_ids": [100, 200], "group_ids": [2]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 191,
    "name": "mycollection",
    "time": "2016-11-25T13:18:44+00:00",
    "internal_domain": "mycollecton.site-factory.com"
  }

Request parameters

Delete a site collection

Delete a site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections/101' \
    -X DELETE \
    -v -u {user_name}:{api_key}

Example response

  {
    "id" : 101,
    "time" : "2016-10-28T09:25:26+00:00",
    "deleted" : true,
    "message" : "Your site collection was successfully deleted."
  }

Request parameters

Add site(s) to a site collection.

Add site(s) to a site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections/191/add' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_ids": [101, 121, 126]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 191,
    "name": "foobarcollection",
    "time": "2017-04-20T10:58:18+00:00",
    "site_ids_added": [
      121
    ],
    "added": true,
    "message": "One site was successfully added to the site collection.",
    "warning": [
      "The site aabbcc (site ID: 101) is already part of the current site collection.; The site ddeeff (site ID: 126) is already part of the current site collection.",
      "Site xxyyzz (site ID: 121) was removed from examplegroup (group ID: 91)."
    ],
    "site_ids_skipped": [
      101,
      126
    ]
  }

Request parameters

Remove site(s) from a site collection.

Remove site(s) from a site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections/191/remove' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_ids": [121]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 191,
    "name": "foobarcollection",
    "time": "2017-04-20T10:58:18+00:00",
    "site_ids_removed": [
      121
    ],
    "removed": true,
    "message": "One site was successfully removed from the site collection."
  }

Request parameters

Set the primary site of a site collection.

Set the primary site of a site collection.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/collections/191/set-primary' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_id": 101}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "id": 191,
    "name": "foobarcollection",
    "time": "2017-04-20T10:58:18+00:00",
    "primary_site_id": 101,
    "switched": true,
    "message": "It can take a few minutes to switch over to the new primary site."
  }

Request parameters

List group members

Get the members of a group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/members?limit=20' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123,
    "count": 3,
    "members": [
      {
        "uid": 101,
        "group owner": true,
        "group administrator": true
      },
      {
        "uid": 106,
        "group owner": false,
        "group administrator": true
      },
      {
        "uid": 111,
        "group owner": false,
        "group administrator": false
      }
    ]
  }

Request parameters

Get a group

Get a group by group ID.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "created": 1399421609,
    "group_id": 123,
    "group_name": "mygroup",
    "owner": "user_name",
    "owner_id": 456,
    "parent_id": 789,
    "parent_name": "parentgroup",
    "live_site_count": 1,
    "total_site_count": 3,
    "status": 1
  }

Request parameters

List groups

Get a list of groups.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups?page=2&limit=20' \
    -v -u {user_name}:{api_key}

Example response

  {
    "count": 123,
    "groups": [
      {
        "group_name": "test",
        "group_id": 10002246,
        "owner": "user_name",
        "owner_id": 10000461,
        "parent_name": "foo",
        "parent_id": 4242,
        "status": 1,
        "created": 1473142941,
        "live_site_count": 1,
        "total_site_count": 2
      },
      {
        "group_name": "subgroup",
        "group_id": 10002251,
        "owner": "user_name",
        "owner_id": 10000461,
        "parent_name": "test",
        "parent_id": 10002246,
        "status": 1,
        "created": 1473142941,
        "live_site_count": 0,
        "total_site_count": 1
      }
    ]
  }

Request parameters

Create a group

Create a site group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"group_name": "mygroup"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "group_id": 123,
    "group_name": "mygroup"
  }

Request parameters

Edit a group

Edit a group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/update' \
    -X PUT -H 'Content-Type: application/json' \
    -d '{"group_name": "mygroup"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123
  }

Request parameters

Delete a group

Delete a site group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}' \
    -X DELETE \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123
  }

Request parameters

Add members to a group

Add members to a group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/members' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"uids": [66, 71]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123,
    "uids_added": [66]
  }

Request parameters

Make members group admin

Make members group admin.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/admins' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"uids": [66, 71]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123,
    "uids_promoted": [66]
  }

Request parameters

Add site(s) to a site group.

Add site(s) to a site group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/191/sites' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"site_ids": [101, 121, 126]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "group_id": 191,
    "name": "foobargroup",
    "time": "2020-04-20T10:58:18+00:00",
    "site_ids_added": [
      121
    ],
    "message": "One site was successfully added to the site group.",
    "site_ids_skipped": [
      101,
      126
    ]
  }

Request parameters

Remove members from a group

Remove members from a group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/members' \
    -X DELETE -H 'Content-Type: application/json' \
    -d '{"uids": [66, 71]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123,
    "uids_removed": [66]
  }

Request parameters

Remove group admin from members

Remove group admin from members.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/admins' \
    -X DELETE -H 'Content-Type: application/json' \
    -d '{"uids": [66, 71]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2016-11-25T13:18:44+00:00",
    "group_id": 123,
    "uids_demoted": [66]
  }

Request parameters

Remove site(s) from a site group.

Remove site(s) from a site group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/191/sites' \
    -X DELETE -H 'Content-Type: application/json' \
    -d '{"site_ids": [121, 101, 126]}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "group_id": 191,
    "name": "foobargroup",
    "time": "2020-04-20T10:58:18+00:00",
    "site_ids_removed": [
      121
    ],
    "message": "One site was successfully removed from the site group.",
    "site_ids_skipped": [
      101,
      126
    ]
  }

Request parameters

List sites in a group.

Get the sites of a group.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/groups/{group_id}/sites?limit=20' \
    -v -u {user_name}:{api_key}

Example response

  {
    "time": "2021-02-19T12:54:23+00:00",
    "group_id": 101,
    "count": 2,
    "sites": [
      {
        "id": 151,
        "db_name": "iade151",
        "site": "site1",
        "stack_id": 1,
        "domain": "{base_url}",
        "groups": [
          91
        ],
        "site_collection": 5,
        "is_primary": true
      },
      {
        "id": 156,
        "db_name": "iade156",
        "site": "site2",
        "stack_id": 1,
        "domain": "{base_url}",
        "groups": [
          91
        ],
        "site_collection": 6,
        "is_primary": true
      }
    ]
  }

Request parameters

Send a theme notification

Sends a theme event notification.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/theme/notification' \
    -v -u {user_name}:{api_key} -X POST \
    -H 'Content-Type: application/json' \
    -d '{"scope": "site", "event": "modify", "nid": 123}'

Example response

  {
    "message": "The site.modify notification has been received.",
    "time": "2014-02-16T20:04:12-06:00",
    "notification": {
      "scope": "site",
      "event": "modify",
      "nid": 123
    }
  }

Request parameters

External theme repository deploy key

Gets the deploy key that needs to be added to external theme repositories.

Add this deploy key to your theme repositories, so that the Acquia Cloud Site Factory platform gets access to your repository and is able to deploy updated themes to your sites.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/theme/deploy-key' \
    -v -u {user_name}:{api_key}

Example response

  {
    "deploy_key": "ssh-rsa...== id_rsa_external_theme",
    "time": "2034-05-11T18:15:19+00:00"
  }

Process theme modifications

Processes the stored theme change notifications.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/theme/process' \
    -H 'Content-Type: application/json' \
    -X POST -d '{"sitegroup_id": "tangle001"}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "message": "The request to process theme notification has been accepted.",
    "sitegroups": [
      "tangle001"
    ],
    "time": "2014-05-02T16:21:25+00:00"
  }

Request parameters

Get domains

Get domains by node ID.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/domains/{node_id}' \
    -v -u {user_name}:{api_key}

Example response

  {
    "node_id": 121,
    "node_type": "site collection",
    "time": "2016-10-28T09:25:26+00:00",
    "domains": {
      "protected_domains": [
        "site.example.sfdev.acquia-test.co"
      ],
      "custom_domains": [
        "www.abc.com/def",
        "www.xyz.com"
      ]
    }
  }

Request parameters

Get domain status

Get domain status.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/domains/status/www.example.com' \
    -v -u {user_name}:{api_key}

Example response

  {
    "domain_name": "www.example.com",
    "associated_status": "registered|registered_unstable|unregistered|unregistered_unstable",
    "node_id": 123,
    "node_type": "site",
    "stack_id": 1,
    "time": "2016-10-28T09:25:26+00:00"
  }

Request parameters

Add domain

Adds a domain.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/domains/{node_id}/add' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"domain_name": "www.domaintoadd.com" }' \
    -v -u {user_name}:{api_key}

Example response

  {
    "node_id": 121,
    "node_type": "site collection",
    "domain": "www.domaintoadd.com",
    "time": "2016-10-28T09:25:26+00:00",
    "added": true,
    "messages": [
      "Your domain name was successfully added to the site collection."
    ]
  }

Request parameters

Remove domain

Removes a domain.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/domains/{node_id}/remove' \
    -X POST -H 'Content-Type: application/json' \
    -d '{"domain_name": "www.domaintoremove.com" }' \
    -v -u {user_name}:{api_key}

Example response

  {
    "node_id": 121,
    "node_type": "site collection",
    "domain": "www.domaintoremove.com",
    "time": "2016-10-28T09:25:26+00:00",
    "removed": true,
    "message": "Your domain name has been successfully removed from <site collection name>."
  }

Request parameters

Regenerate ALL users API keys

Regenerate ALL users API keys.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/users/all/api-keys' \
    -X DELETE -H 'Content-Type: application/json' \
    -v -u {user_name}:{api_key}

Example response

  {
    "message": "API keys will be regenerated in a few minutes",
    "server_time": "2014-02-16T20:04:12-06:00",
    "task_id": 1234
  }

Regenerate a user's API key

Regenerate a user's API key.

Example command

  curl 'https://www.demo.acquia-cc.com/api/v1/users/32/api-keys' \
    -X DELETE -H 'Content-Type: application/json' \
    -v -u {user_name}:{api_key}

Example response

  {
    "message": "The API key for user 32 was regenerated.",
    "server_time": "2014-02-16T20:04:12-06:00"
  }

Request parameters