Skip to content

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

StatusDescriptionBody
200Ownership markersapplication/json: DeclarativeObjectList
403Admin 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

FieldTypeRequiredDescription
itemsarray of objectyes-
items[].applied_hashstringnoMaximum length: 128.
items[].kindstringyesOne of: User, Project, Group, Repository, PermissionTarget, SSOProvider, Webhook, StorageTier, TierPolicy.
items[].namestringyesMinimum length: 1. Maximum length: 512.
items[].object_idstringyesMinimum length: 1. Maximum length: 256.

Responses

StatusDescriptionBody
200Stored markersapplication/json: DeclarativeObjectList
400Validation failed-
403Admin access required-

DELETE /api/v1/admin/declarative ​

Delete a declarative ownership marker

Remove one marker (admin only); the managed object itself is untouched

Parameters

NameInTypeRequiredDescription
kindquerystringyes-
namequerystringyesObject name; may contain /

Responses

StatusDescriptionBody
204Marker deleted-
400Validation failed-
403Admin access required-
404No such marker-

Free software under the AGPL-3.0-or-later.