Sites

Creates a site for a codebase.

post/sites

Request

Base URL
https://api.acquia.com/v3
Auth
HTTP bearer
TypeScript
https://skmtc.dev/acquia/apis/acquia-cloud-platform-api/docs/sites/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

The machine name of the site. Must start with a lowercase letter and contain only lowercase letters and numbers.

labelstring required

The human-readable label for the site.

codebase_idstring required

The unique identifier of the codebase to associate with this site.

site_idstring uuid

An optional explicit UUID for the new site. A UUID is generated automatically if omitted.

descriptionstring

An optional description for the site.

Example request

{
  "name": "mysite",
  "label": "My Site",
  "codebase_id": "a9b8c7d6-e5f4-3210-abcd-ef9876543210",
  "site_id": "0ebce493-9d09-479d-a9a8-138a206fa687",
  "description": "A production site for the marketing team."
}

Response

Site created

_embeddedobject

Embedded resources (optional)

message'Site creation started.' required

Confirmation message indicating site creation has been initiated

Example response

{
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.