Skip to navigation
OrganizationsShare Agreements

Backfill Share Agreements

Add a new resource to all existing share agreements that don't already have it.

Useful when a new resource is introduced and existing agreements need to be updated without running manual database queries. Share agreements that already include the resource are skipped. Optionally restrict the update to specific fleets.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
resourceenumRequired
The resource to add to share agreements that don't have it
share_levelenumOptional
The permission level to assign to the resource
Allowed values:
fleet_idslist of strings or nullOptional
Limit the backfill to specific fleets. If omitted, all fleets are affected.

Response

Successful Response
share_agreement_idslist of strings
IDs of the share agreements that were updated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error