Automations
Link to GitHub
Open a pull request containing the definition.
TypeScript SDKThe npm client, generated from the API spec.Python SDKThe PyPI client, sync and async.
| Method | Path | Required permissions |
|---|---|---|
| POST | /v1/automations/{automation_id}/link | write:configs |
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.
Git takes ownership when that pull request merges and syncs.
Path parameters
automation_idstringrequired
curl -X POST "https://api.ellipsis.dev/v1/automations/{automation_id}/link" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"repository": "api-repo"
}'import os
from ellipsis import Ellipsis
from ellipsis import models
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
request = models.LinkAutomationRequest.model_validate(
{
"repository": "api-repo"
}
)
result = client.automations.link("check-tests", request.repository)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const request: Parameters<typeof client.automations.link>[1] = {
"repository": "api-repo"
};
const result = await client.automations.link("check-tests", request);
console.log(result);Request
Example request body
{
"repository": "api-repo"
}
Body parameters
pathstring
File path within the repo. Omit for the default .ellipsis/automations/<slug>.yaml; if set it must be a location the sync scans (a .yaml/.yml file under .ellipsis/ at any depth; in the repository named .ellipsis the repo root is that directory).
repositorystringrequired
Repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. "my-service"), not "owner/my-service".
Response
Example response, 200
{
"path": "string",
"pull_request_url": "string"
}