API
API reference
The REST API, grouped the way the OpenAPI document tags it. Each page lists its operations with method and path.
- Base URL
- https://yp-api.fleetworks.dev
- Areas
- 18
- Operations
- 80
- Admin users2 opsThe user list and account changes for administrators.
- Services6 opsService entries: the catalog’s main resource, keyed by name.
- Agents7 opsAgent entries, plus the idempotent registration call Coastguard uses.
- Teams6 opsThe engineering teams that own Services and Agents.
- AWS accounts6 opsAWS accounts by account id, with onboarding and provisioning state.
- VCS tenants5 opsGitHub orgs, GitLab groups and Azure DevOps orgs, keyed by provider and slug.
- Compositions6 opsDeclared groups of Services and Agents, and their resolved plan.
- Azure accounts6 opsAzure subscriptions by subscription id.
- Labels5 opsUniquely named tags for services, agents, teams and accounts.
- Search1 opsOne query across the catalog.
- Catalog auditor2 opsDeterministic findings about catalog metadata.
- Agent sources2 opsPackages and pinned refs from an Agent’s definition source.
- Directory3 opsTeams and people from the configured directory provider.
- API keys3 opsCreate, list and revoke machine keys.
- Webhooks7 opsSubscriptions, test deliveries and the delivery log.
- Connectors3 opsPer-Service connector results and connector actions.
- Operational graph2 opsTyped nodes and edges, one node or a traversal up to six hops.
- Moderation8 opsContent reports, user blocks, terms acceptance and the moderator queue.