Get site information with the Pantheon Public API
Get site information
Learn how to look up a Pantheon site by its UUID or name using the Pantheon Public API.
Most site operations in the Pantheon Public API identify the site by its UUID. This page shows how to get information about a site, and how to find a site's UUID from its name.
The examples on this page assume your Personal Access Token is stored in the PANTHEON_TOKEN environment variable. See Authenticate with the Public API.
Get site information
Request a site by its UUID, replacing <site_uuid>:
The response includes the site's machine name, label, region, upstream, settings, and multidev environments. For example, to show a few of those fields with jq:
You can only request sites that your Pantheon account has access to. If you request a site that doesn't exist or that you can't access, the API returns an HTTP 403 error.
If a site has no multidev environments, multidevEnvironmentNames can be an empty array or null. Handle both in your scripts.
Find a site's UUID
If you know the site's machine name but not its UUID, look it up by name, replacing <site_name>:
The response is the site's UUID as a quoted JSON string, which you can use in other requests. Use jq -r to remove the quotes.
You can also find a site's UUID in the Site Dashboard URL: https://dashboard.pantheon.io/sites/<site_uuid>.
Next steps
Start a workflow to create a multidev environment on your site.
