Skip to navigation

Delete Connection

Deletes a connection.

A Connection that backs any active Harbor returns 409 Conflict, including when you pass force=true. No dependent resources are deleted in this case. Delete the Harbor first. Deleting a managed Harbor also deletes its managed Connection; deleting a customer-managed Harbor preserves its backing Connection.

🚧 Deleting a connection that is referenced by fieldsets, syncs, bulk syncs, or schedules returns 422 connection in use unless you pass force=true. With force=true, the API deletes those dependent resources before removing the connection.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Connection ID

Headers

X-Polytomic-VersionstringOptional

Query parameters

forcebooleanOptional
Delete the connection with the models and syncs that depend on it.

Response

No Content

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error