---
title: "Get an environment's deployment settings"
url: https://docs.corefinity.com/api/reference/enterprise/get-environment-deployment-settings
type: endpoint
last_updated: 2026-11-13
feature: enterprise-deployments
related:
  - https://docs.corefinity.com/guides/corestack-enterprise/deployments-and-pipelines.md
---
# Get an environment's deployment settings

Answers how the environment deploys: whether its pipeline is on, its deployment source, whether a push deploys
on its own, and each of its pipelines with its folders and build switches.

```http
GET /api/environments/{environment}/deployment-settings
```

- Scope: `read`
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

- `environment` (integer, required): The id of a CoreStack Enterprise environment. Not the same number as a site row id.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/environments/1311/deployment-settings \
  -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/environments/1311/deployment-settings');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/environments/1311/deployment-settings', {
  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/environments/1311/deployment-settings",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The deployment settings.

```json
{
  "deployment_settings": {
    "deployment_source": "git",
    "deployment_sources": [
      "manual",
      "git"
    ],
    "enterprise_env_id": 1311,
    "git_deploys": "manual",
    "pipeline_enabled": true,
    "pipelines": [
      {
        "build_switches_editable": false,
        "folders_editable": true,
        "isolate_build_var": null,
        "name": "Storefront (Wordpress)",
        "notes": [],
        "pause_crons_during_build": null,
        "pipeline_id": 2210,
        "root_directory": "/var/www/harbourandfinch.example.com/",
        "root_storage": "/var/www/harbourandfinch.example.com/shared/"
      }
    ],
    "repositories": 1
  }
}
```

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

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

### 403 The token lacks the scope this endpoint needs. `scope` names it.

```json
{
  "code": "scope_required",
  "message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
  "reason": "scope_required",
  "scope": "destructive"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 422 The environment is a CoreStack or CoreCluster site's (`invalid` on `environment`). Use the site's endpoints instead.

```json
{
  "code": "invalid",
  "errors": {
    "environment": [
      "This is a CoreStack or CoreCluster environment: name it by its site_id."
    ]
  },
  "field": "environment",
  "message": "This is a CoreStack or CoreCluster environment: name it by its site_id.",
  "reason": "invalid"
}
```

### 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 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 |  | Check the id. You see only what your account can reach. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Deployments and pipelines](https://docs.corefinity.com/guides/corestack-enterprise/deployments-and-pipelines.md)
