Sites

Retrieves a site by its ID.

get/sites/{siteId}

Request

Path parameters

siteIdstring required
Example:12345678-1234-1234-1234-123456789012

Unique identifier for the site

Response

Site details

idstring required

The unique identifier of the site

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 of the site

descriptionstring

A description of the site

codebase_idstring required

The unique identifier of the codebase this site belongs to

status'ready' | 'marked-for-deletion' required

The current lifecycle status of the site. ready indicates the site is active and operational. marked-for-deletion indicates the site has been scheduled for deletion and can still be recovered.

delete_atstring date-time

ISO 8601 datetime indicating when the site is scheduled for deletion. Only present when status is marked-for-deletion.

_embeddedobject

Embedded resources (optional)

Example response

{
  "id": "12345678-1234-1234-1234-123456789012",
  "name": "mysite",
  "label": "My Site 1",
  "description": "A production site for the marketing team.",
  "codebase_id": "550e8400-e29b-41d4-a716-446655441210",
  "status": "ready",
  "delete_at": "2025-06-15T00:00:00Z",
  "_links": {
    "self": {
      "href": "https://api.acquia.com/v3/resources/1"
    },
    "codebase": {
      "href": "https://api.acquia.com/v3/resources/1"
    }
  }
}

Changes

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