Secrets
Secrets
Secrets endpoints of the Ellipsis REST API.
| Method | Path | Required permissions |
|---|---|---|
| PUT | /v1/secrets | write:secrets |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Unavailable. Not supported by sandbox tokens, even with permissions.ellipsis enabled.
Higher permission levels include lower levels: read < write < delete.
Grant match patterns can further restrict access to individual resources.
Values cannot be read back.
curl -X PUT "https://api.ellipsis.dev/v1/secrets" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"secrets": [
{
"name": "NPM_TOKEN",
"value": "replace-me"
}
]
}'import os
from ellipsis import Ellipsis
from ellipsis import models
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
request = models.PutSecretsRequest.model_validate(
{
"secrets": [
{
"name": "NPM_TOKEN",
"value": "replace-me"
}
]
}
)
result = client.secrets.set(request.secrets)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const request: Parameters<typeof client.secrets.set>[0] = {
"secrets": [
{
"name": "NPM_TOKEN",
"value": "replace-me"
}
]
};
const result = await client.secrets.set(request);
console.log(result);Request
Example request body
{
}
Body parameters
secretsarray<SecretInput>required
The secrets to store.
Response
Example response, 200
{
}
| Method | Path | Required permissions |
|---|---|---|
| GET | /v1/secrets | read:secrets |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Requires the ellipsis:api scope and the required grants in the token's permissions.ellipsis configuration.
Higher permission levels include lower levels: read < write < delete.
Grant match patterns can further restrict access to individual resources.
Values are never returned.
curl "https://api.ellipsis.dev/v1/secrets" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.secrets.list()
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.secrets.list();
console.log(result);Request
Response
Example response, 200
{
}
| Method | Path | Required permissions |
|---|---|---|
| DELETE | /v1/secrets/{name} | delete:secrets |
Token access
- API key
- Supported.
- CLI user token
- Supported.
- Sandbox token
- Unavailable. Not supported by sandbox tokens, even with permissions.ellipsis enabled.
Higher permission levels include lower levels: read < write < delete.
Grant match patterns can further restrict access to individual resources.
New sessions that require it will fail.
Path parameters
namestringrequired
curl -X DELETE "https://api.ellipsis.dev/v1/secrets/{name}" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN"import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.secrets.delete("NPM_TOKEN")
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.secrets.delete("NPM_TOKEN");
console.log(result);