# Codebahn Admin API

**Canonical:** https://apis.io/apis/codebahn-net/codebahn-net-admin-api/  
**Provider:** Codebahn — https://apis.io/providers/codebahn-net/  
**Base URL:** https://codebahn.net/api/v1  
**Documentation:** https://codebahn.net/api/swagger

Codebahn Admin API is one of 10 APIs that [Codebahn](https://apis.io/providers/codebahn-net/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

The admin API from Codebahn — 32 operation(s) for admin.

## Operations (48)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/actions/runners` | Get all runners, no matter whether they are global runners or scoped to an… |
| POST | `/admin/actions/runners` | Register a new global runner |
| GET | `/admin/actions/runners/jobs` | Get action run jobs |
| GET | `/admin/actions/runners/registration-token` | Get a runner registration token for registering global runners |
| GET | `/admin/actions/runners/{runner_id}` | Get a particular runner, no matter whether it is a global runner or scoped to… |
| DELETE | `/admin/actions/runners/{runner_id}` | Delete a particular runner, no matter whether it is a global runner or scoped… |
| GET | `/admin/cron` | List cron tasks |
| POST | `/admin/cron/{task}` | Run cron task |
| GET | `/admin/emails` | List all users' email addresses |
| GET | `/admin/emails/search` | Search users' email addresses |
| GET | `/admin/hooks` | List global (system) webhooks |
| POST | `/admin/hooks` | Create a hook |
| GET | `/admin/hooks/{id}` | Get a hook |
| DELETE | `/admin/hooks/{id}` | Delete a hook |
| PATCH | `/admin/hooks/{id}` | Update a hook |
| GET | `/admin/orgs` | List all organizations |
| GET | `/admin/quota/groups` | List the available quota groups |
| POST | `/admin/quota/groups` | Create a new quota group |
| GET | `/admin/quota/groups/{quotagroup}` | Get information about the quota group |
| DELETE | `/admin/quota/groups/{quotagroup}` | Delete a quota group |
| PUT | `/admin/quota/groups/{quotagroup}/rules/{quotarule}` | Adds a rule to a quota group |
| DELETE | `/admin/quota/groups/{quotagroup}/rules/{quotarule}` | Removes a rule from a quota group |
| GET | `/admin/quota/groups/{quotagroup}/users` | List users in a quota group |
| PUT | `/admin/quota/groups/{quotagroup}/users/{username}` | Add a user to a quota group |
| DELETE | `/admin/quota/groups/{quotagroup}/users/{username}` | Remove a user from a quota group |
| GET | `/admin/quota/rules` | List the available quota rules |
| POST | `/admin/quota/rules` | Create a new quota rule |
| GET | `/admin/quota/rules/{quotarule}` | Get information about a quota rule |
| DELETE | `/admin/quota/rules/{quotarule}` | Deletes a quota rule |
| PATCH | `/admin/quota/rules/{quotarule}` | Change an existing quota rule |
| GET | `/admin/runners/jobs` | Search action jobs according to filter conditions |
| GET | `/admin/runners/registration-token` | Get a runner registration token for registering global runners |
| GET | `/admin/unadopted` | List unadopted repositories |
| POST | `/admin/unadopted/{owner}/{repo}` | Adopt unadopted files as a repository |
| DELETE | `/admin/unadopted/{owner}/{repo}` | Delete unadopted files |
| GET | `/admin/users` | Search users according filter conditions |
| POST | `/admin/users` | Create a user account |
| DELETE | `/admin/users/{username}` | Delete user account |
| PATCH | `/admin/users/{username}` | Edit an existing user |
| GET | `/admin/users/{username}/emails` | List all email addresses for a user |
| DELETE | `/admin/users/{username}/emails` | Delete email addresses from a user's account |
| POST | `/admin/users/{username}/keys` | Add an SSH public key to user's account |
| DELETE | `/admin/users/{username}/keys/{id}` | Remove a public key from user's account |
| POST | `/admin/users/{username}/orgs` | Create an organization |
| GET | `/admin/users/{username}/quota` | Get the user's quota info |
| POST | `/admin/users/{username}/quota/groups` | Set the user's quota groups to a given list |
| POST | `/admin/users/{username}/rename` | Rename a user |
| POST | `/admin/users/{username}/repos` | Create a repository on behalf of a user |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/codebahn-net/openapi/codebahn-net-admin-api-openapi.yml
- **Documentation** — https://codebahn.net/docs/

## Other Codebahn APIs (9)

- [Codebahn Activitypub API](https://apis.io/apis/codebahn-net/codebahn-net-activitypub-api/)
- [Codebahn Issue API](https://apis.io/apis/codebahn-net/codebahn-net-issue-api/)
- [Codebahn Miscellaneous API](https://apis.io/apis/codebahn-net/codebahn-net-miscellaneous-api/)
- [Codebahn Notification API](https://apis.io/apis/codebahn-net/codebahn-net-notification-api/)
- [Codebahn Organization API](https://apis.io/apis/codebahn-net/codebahn-net-organization-api/)
- [Codebahn Package API](https://apis.io/apis/codebahn-net/codebahn-net-package-api/)
- [Codebahn Repository API](https://apis.io/apis/codebahn-net/codebahn-net-repository-api/)
- [Codebahn Settings API](https://apis.io/apis/codebahn-net/codebahn-net-settings-api/)
- [Codebahn User API](https://apis.io/apis/codebahn-net/codebahn-net-user-api/)

## Tags

Admin

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/codebahn-net/codebahn-net-admin-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/codebahn-net/.
