---
title: "Get what a new environment starts with"
url: https://docs.corefinity.com/api/reference/environments/get-environment-starts-with
type: endpoint
last_updated: 2026-11-13
feature: environments
related:
  - https://docs.corefinity.com/guides/sites/environments-and-copies/create-an-environment.md
  - https://docs.corefinity.com/mcp/tools/corestack_environment_starts_with_get.md
---
# Get what a new environment starts with

Answers what a new staging environment of the site inherits before you add it, and that HTTP authentication
protects it from the start. A part that is not available for the site is answered as null.
`{site}` is any row of the site; a site that cannot take a new environment now is refused as adding one is.

```http
GET /api/corestack/sites/{site}/environments/starts-with
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/environments/starts-with \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites/1042/environments/starts-with');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/environments/starts-with', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/sites/1042/environments/starts-with",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 What the new environment starts with.

```json
{
  "firewall": {
    "closed_to_others": false,
    "inherited": 2,
    "items": [
      {
        "cidr": "203.0.113.10/32",
        "layer": "website",
        "owner": {
          "id": 1302,
          "name": "harbourandfinch.example.com",
          "type": "website"
        },
        "scope": "both"
      },
      {
        "cidr": "198.51.100.24/32",
        "layer": "company",
        "owner": {
          "id": 1204,
          "name": "Harbour & Finch",
          "type": "company"
        },
        "scope": "both"
      }
    ],
    "presets": [
      {
        "layer": "company",
        "name": "GitHub Actions",
        "owner": {
          "id": 1204,
          "name": "Harbour & Finch",
          "type": "company"
        },
        "ranges": 1,
        "slug": "github-actions"
      }
    ],
    "stage": "dark"
  },
  "http_auth": {
    "enabled": true
  },
  "ssh": {
    "items": [
      {
        "layer": "company",
        "name": "Deploy key",
        "owner": {
          "id": 1204,
          "name": "Harbour & Finch",
          "type": "company"
        }
      }
    ],
    "keys": 1
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The site cannot take a new environment now, so there is nothing to show. `reason` says why: `managed_elsewhere` (checked first), `deleted`, `provisioning` or `site_unadopted` (the site is not ready to be changed from the Control Panel; contact support).

```json
{
  "code": "deleted",
  "message": "This site is deleted. Restore it first.",
  "reason": "deleted"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 409 | `deleted` | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `provisioning` | The site is still being created. Try again in a few minutes. |
| 409 | `site_unadopted` | This site is not ready to be changed from the Control Panel yet. Contact support. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Create an environment](https://docs.corefinity.com/guides/sites/environments-and-copies/create-an-environment.md)
- MCP tool: [`corestack_environment_starts_with_get`](https://docs.corefinity.com/mcp/tools/corestack_environment_starts_with_get.md)
