Skip to navigation

Set Harbor Action Configuration

Beta

Creates or replaces action grants for an eligible Harbor source Connection.

You must be an Organization administrator with permission to edit both the Harbor and the source Connection. Use a normal writable API credential, not a Harbor profile credential. Your Organization must have the Harbor Actions entitlement.

The Connection must populate the Harbor through a non-deleted Bulk Sync or Model Sync targeting its backing Connection. This requirement applies to new grants and replacements, even when you only remove fields from an existing grant.

Submit the complete grant set for this Connection. Omit expected_revision to create it, or supply the current revision to replace it. A missing, stale, or unexpected revision returns 409 Conflict; read configuration again before retrying. Successful replacement creates a new revision.

For mutating operations, field_ids selects input fields and lookup_field_ids must be omitted. For read-only operations, field_ids selects output fields and lookup_field_ids selects allowed lookup fields. Duplicate operations or field IDs are invalid. An empty grant set is invalid; remove the Connection’s grants instead.

This request changes permissions only. It does not execute provider actions.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

harbor_idstringRequiredformat: "uuid"
Unique identifier of the Harbor.
connection_idstringRequiredformat: "uuid"
Source Connection whose action grants you want to manage.

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
grantslist of objects or nullRequired
Complete replacement of this Connection's action grants.
expected_revisionstringOptionalformat: "uuid"
Current revision when replacing existing grants. Omit when creating grants for this Connection.

Response

OK
datalist of objects or nullOptional
All configured action Connections after this request.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error
503
Service Unavailable Error