Declarative API
3 endpoints. Request and response schemas are described on the schemas page; the other tags are listed in the API index.
Endpoints
GET /api/v1/admin/declarative
List declarative ownership markers
List the objects created or adopted by oa apply (admin only)
Responses
| Status | Description | Body |
|---|---|---|
200 | Ownership markers | application/json: DeclarativeObjectList |
403 | Admin access required | - |
PUT /api/v1/admin/declarative
Upsert declarative ownership markers
Upsert markers by (kind, name) in one transaction; at most 1000 items (admin only)
Request body (required)
application/json: object
| Field | Type | Required | Description |
|---|---|---|---|
items | array of object | yes | - |
items[].applied_hash | string | no | Maximum length: 128. |
items[].kind | string | yes | One of: User, Project, Group, Repository, PermissionTarget, SSOProvider, Webhook, StorageTier, TierPolicy. |
items[].name | string | yes | Minimum length: 1. Maximum length: 512. |
items[].object_id | string | yes | Minimum length: 1. Maximum length: 256. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Stored markers | application/json: DeclarativeObjectList |
400 | Validation failed | - |
403 | Admin access required | - |
DELETE /api/v1/admin/declarative
Delete a declarative ownership marker
Remove one marker (admin only); the managed object itself is untouched
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | string | yes | - |
name | query | string | yes | Object name; may contain / |
Responses
| Status | Description | Body |
|---|---|---|
204 | Marker deleted | - |
400 | Validation failed | - |
403 | Admin access required | - |
404 | No such marker | - |