---
title: "Create a registry secret"
url: https://docs.corefinity.com/api/reference/deployments/create-environment-registry-secret
type: endpoint
last_updated: 2026-11-13
feature: registry-secrets
related:
  - https://docs.corefinity.com/guides/sites/code-and-deployments/registry-secrets.md
---
# Create a registry secret

Saves the credential for one Composer registry. The registry is named by its host, with a port when it needs
one; it must resolve to public addresses. An environment holds one credential for each registry. A saved
credential is used by the environment's builds once registry credentials are switched on for it.

```http
POST /api/corestack/environments/{environment}/deploy-secrets
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

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

## Body

- `auth_type` (string, required): How the registry signs in. One of `http-basic`, `bearer`, `github-oauth`, `gitlab-token`.
- `label` (string, required): A name for the credential, on one line. Spaces around it are removed, and it cannot be blank.
- `registry` (string, required): The registry's host name, with a port if it needs one. No scheme, path or spaces.
- `secret` (string, required): The token or password, kept exactly as sent. No line breaks or control characters.
- `username` (string): The username, with no line breaks or control characters. Required and not blank for `http-basic`, and not kept for any other sign-in type.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/environments/1311/deploy-secrets \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "auth_type": "http-basic",
    "label": "Private packages",
    "registry": "packages.example.com",
    "secret": "your-registry-token",
    "username": "northwind-digital"
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/environments/1311/deploy-secrets', [
        'auth_type' => 'http-basic',
        'label' => 'Private packages',
        'registry' => 'packages.example.com',
        'secret' => 'your-registry-token',
        'username' => 'northwind-digital',
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/environments/1311/deploy-secrets', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    auth_type: 'http-basic',
    label: 'Private packages',
    registry: 'packages.example.com',
    secret: 'your-registry-token',
    username: 'northwind-digital',
  }),
});

// 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.post(
    "https://manage.corefinity.com/api/corestack/environments/1311/deploy-secrets",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "auth_type": "http-basic",
        "label": "Private packages",
        "registry": "packages.example.com",
        "secret": "your-registry-token",
        "username": "northwind-digital",
    },
)

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

## Responses

### 201 The saved credential.

```json
{
  "data": {
    "auth_type": "http-basic",
    "id": 319,
    "kind": "composer",
    "label": "Private packages",
    "last4": "oken",
    "last_used_at": null,
    "registry": "packages.example.com",
    "scope": "",
    "verified_at": null
  }
}
```

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

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

### 403 The token lacks the `write` scope (`scope_required`), your company requires two-factor authentication and you have not set it up, or your role lacks the Edit Environment Deployment Pipeline permission (`forbidden`, with `permission`).

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

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

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

### 409 The environment already has a credential for this registry (`exists`). `id` is the saved one. Change that one instead.

```json
{
  "code": "exists",
  "id": 318,
  "message": "A registry for this host is already saved. Edit it instead.",
  "reason": "exists"
}
```

### 422 The request was refused and nothing was saved. `errors` names the field. - `secret_invalid`: a field is missing or is a value the rules refuse (the label, the registry's host, the sign-in type, the username for `http-basic`, the token), the registry's address is not public or does not resolve, the environment holds as many credentials as it can, or its credentials would be too large together. - `invalid`: the body is not a JSON object (on `request`), a change names nothing to change, or the environment belongs to a CoreStack or CoreCluster site (on `environment`).

```json
{
  "code": "secret_invalid",
  "errors": {
    "auth_type": [
      "Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token."
    ]
  },
  "message": "Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token.",
  "reason": "secret_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 | `company_unavailable` | Your company is unavailable. |
| 403 | `forbidden` | The person is not allowed to do this. |
| 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 |  | Check the id. You see only what your account can reach. |
| 409 | `exists` | It already exists. Use the existing one. |
| 422 | `secret_invalid` | Choose how the registry signs in: http-basic, bearer, github-oauth or gitlab-token. |
| 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: [Private registries](https://docs.corefinity.com/guides/sites/code-and-deployments/registry-secrets.md)
