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.
Path parameters
The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.
Body
How the registry signs in.
http-basicbearergithub-oauthgitlab-tokenA name for the credential, on one line. Spaces around it are removed, and it cannot be blank. Up to 255 characters.
The registry's host name, with a port if it needs one. No scheme, path or spaces. Up to 255 characters.
The token or password, kept exactly as sent. No line breaks or control characters. Up to 4,096 characters.
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. Up to 255 characters.
Returns
201 The saved credential.
Fields of the 201 answer
One saved registry credential. Never its token or its username.
Fields
How the registry signs in.
http-basicbearergithub-oauthgitlab-tokenAt least 1.
Always composer on these endpoints.
The name you gave the credential.
The last four characters of the token. Null for a token shorter than 12 characters.
When a build last received the credential, in UTC. Format: date-time.
The registry's host, in lower case, with its port when that is not 443.
Always an empty string for a Composer registry.
When the registry last accepted the credential, in UTC. Null when it has not been checked since it last changed. Format: date-time.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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 | none | 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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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"
}'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();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);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{
"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
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "exists",
"id": 318,
"message": "A registry for this host is already saved. Edit it instead.",
"reason": "exists"
}{
"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"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.